/usr/include/openturns/swig/DrawableImplementation_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 | %define OT_Drawable_doc
"Drawable object.
Notes
-----
In OpenTURNS a Drawable is a drawable element described by:
- its data,
- its attributes: color, line stype, point style, fill style, legend ...
The different drawable elements are:
- :class:`~openturns.BarPlot`
- :class:`~openturns.Cloud`
- :class:`~openturns.Contour`
- :class:`~openturns.Curve`
- :class:`~openturns.Pairs`
- :class:`~openturns.Pie`
- :class:`~openturns.Polygon`
- :class:`~openturns.Staircase`
Examples
--------
>>> import openturns as ot
>>> myGraph = ot.Graph('Normal sample', 'x1', 'x2', True, 'topright')
>>> sample = ot.Normal([0.,0.], [1.,1.], ot.CorrelationMatrix(2)).getSample(10)
>>> myCloud = ot.Cloud(sample, 'blue', 'fsquare', 'A Cloud')
>>> myGraph.add(myCloud)"
%enddef
%feature("docstring") OT::DrawableImplementation
OT_Drawable_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getLegend_doc
"Accessor to the legend of the drawable element.
Returns
-------
legend : str
Legend of the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::getLegend
OT_Drawable_getLegend_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setLegend_doc
"Accessor to the legend of the drawable element.
Parameters
----------
legend : str
Legend of the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::setLegend
OT_Drawable_setLegend_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getPalette_doc
"Accessor to the names of the colors used for the Pie.
Returns
-------
palette : :class:`~openturns.Description`
Names of the colors used for the :class:`~openturns.Pie`. It can be
either the name of a color (e.g. 'red') or an hexadecimal code
corresponding to the RGB (Red, Green, Blue) components of the color
(e.g. '#A1B2C3') or the RGBA (Red, Green, Blue, Alpha) components of the
color (e.g. '#A1B2C3D4')."
%enddef
%feature("docstring") OT::DrawableImplementation::getPalette
OT_Drawable_getPalette_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setPalette_doc
"Accessor to the names of the colors used for the Pie.
Parameters
----------
palette : sequence of str
Names of the colors used for the :class:`~openturns.Pie`. It can be
either the name of a color (e.g. 'red') or an hexadecimal code
corresponding to the RGB (Red, Green, Blue) components of the color
(e.g. '#A1B2C3') or the RGBA (Red, Green, Blue, Alpha) components of the
color (e.g. '#A1B2C3D4'). Use :meth:`GetValidColors` for a list of
available values."
%enddef
%feature("docstring") OT::DrawableImplementation::setPalette
OT_Drawable_setPalette_doc
// ---------------------------------------------------------------------
%define OT_Drawable_BuildDefaultPalette_doc
"Build default palette.
Parameters
----------
n : int :math:`n > 0`
Number of colors needed.
Returns
-------
listColors : :class:`~openturns.Description`
List of n color codes defined according to the default OpenTURNS palette.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().BuildDefaultPalette(4))
[#ff0000,#ccff00,#00ff66,#0066ff]"
%enddef
%feature("docstring") OT::DrawableImplementation::BuildDefaultPalette
OT_Drawable_BuildDefaultPalette_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getColor_doc
"Accessor to the color of the drawable element.
Returns
-------
color : str
Name of the color of the lines within the drawable element. It can be
either the name of a color (e.g. 'red') or an hexadecimal code
corresponding to the RGB (Red, Green, Blue) components of the color
(e.g. '#A1B2C3') or the RGBA (Red, Green, Blue, Alpha) components of the
color (e.g. '#A1B2C3D4'). The alpha channel is taken into account only by
the PDF and PNG formats, for the other format the color is fully
transparent as soon as its alpha channel is less than 255 (or 1.0).
Use :meth:`GetValidColors` for a list of available values.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().getColor())
blue
See Also
--------
setColor, GetValidColors, getColorCode"
%enddef
%feature("docstring") OT::DrawableImplementation::getColor
OT_Drawable_getColor_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setColor_doc
"Accessor to the color of the drawable element.
Parameters
----------
color : str
Describes the color of the lines within the drawable element. It can be
either the name of a color (e.g. 'red') or an hexadecimal code
corresponding to the RGB (Red, Green, Blue) components of the color
(e.g. '#A1B2C3') or the RGBA (Red, Green, Blue, Alpha) components of the
color (e.g. '#A1B2C3D4'). The alpha channel is taken into account only by
the PDF and PNG formats, for the other format the color is fully
transparent as soon as its alpha channel is less than 255 (or 1.0).
Use :meth:`GetValidColors` for a list of available values.
See Also
--------
getColor, GetValidColors, getColorCode"
%enddef
%feature("docstring") OT::DrawableImplementation::setColor
OT_Drawable_setColor_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getColorCode_doc
"Accessor to the code of the color of the drawable element.
Returns
-------
color : str
Hexadecimal code corresponding to the RGB (Red, Green, Blue) components
of the color of the lines within the drawable element
or the RGBA (Red, Green, Blue, Alpha) components of the color.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().getColorCode())
#0000FF
See Also
--------
setColor, getColor, GetValidColors, setColorCode"
%enddef
%feature("docstring") OT::DrawableImplementation::getColorCode
OT_Drawable_getColorCode_doc
// ---------------------------------------------------------------------
%define OT_Drawable_GetValidColors_doc
"Return the list of the valid colors of the drawable element.
Returns
-------
validColors : :class:`~openturns.Description`
List of the valid colors of the drawable element.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().GetValidColors()[:5])
[aliceblue,antiquewhite,antiquewhite1,antiquewhite2,antiquewhite3]"
%enddef
%feature("docstring") OT::DrawableImplementation::GetValidColors
OT_Drawable_GetValidColors_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getEdgeColor_doc
"Accessor to the color of the Polygon edge.
Returns
-------
edgeColor : str
Color of the edge of the :class:`~openturns.Polygon`."
%enddef
%feature("docstring") OT::DrawableImplementation::getEdgeColor
OT_Drawable_getEdgeColor_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getFillStyle_doc
"Accessor to the fill style of the drawable element.
Returns
-------
fillStyle : str
Fill style of the surfaces within the drawable element. Use
:meth:`GetValidFillStyles` for a list of available values.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().getFillStyle())
solid"
%enddef
%feature("docstring") OT::DrawableImplementation::getFillStyle
OT_Drawable_getFillStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setFillStyle_doc
"Accessor to the fill style of the drawable element.
Parameters
----------
fillStyle : str
Fill style of the surfaces within the drawable element. Use
:meth:`GetValidFillStyles` for a list of available values."
%enddef
%feature("docstring") OT::DrawableImplementation::setFillStyle
OT_Drawable_setFillStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_GetValidFillStyles_doc
"Return the list of the valid fill styles of the drawable element.
Returns
-------
validFillStyles : :class:`~openturns.Description`
List of the valid fill styles of the drawable element.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().GetValidFillStyles()[:2])
[solid,shaded]
"
%enddef
%feature("docstring") OT::DrawableImplementation::GetValidFillStyles
OT_Drawable_GetValidFillStyles_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getLineWidth_doc
"Accessor to the line width of the drawable element.
Returns
-------
lineWidth : int
Width of the line within the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::getLineWidth
OT_Drawable_getLineWidth_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setLineWidth_doc
"Accessor to the line width of the drawable element.
Parameters
----------
lineWidth : positive int
Width of the line within the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::setLineWidth
OT_Drawable_setLineWidth_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getLineStyle_doc
"Accessor to the line style of the drawable element.
Returns
-------
lineStyle : str
Style of the line within the drawable element. Use
:meth:`GetValidLineStyles` for a list of available values.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().getLineStyle())
solid"
%enddef
%feature("docstring") OT::DrawableImplementation::getLineStyle
OT_Drawable_getLineStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setLineStyle_doc
"Accessor to the line style of the drawable element.
Parameters
----------
lineStyle : str
Style of the line within the drawable element. Use
:meth:`GetValidLineStyles` for a list of available values."
%enddef
%feature("docstring") OT::DrawableImplementation::setLineStyle
OT_Drawable_setLineStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_GetValidLineStyles_doc
"Return the list of the valid line styles of the drawable element.
Returns
-------
validLineStyles : :class:`~openturns.Description`
List of the valid line styles of the drawable element.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().GetValidLineStyles())
[blank,solid,dashed,dotted,dotdash,longdash,twodash]"
%enddef
%feature("docstring") OT::DrawableImplementation::GetValidLineStyles
OT_Drawable_GetValidLineStyles_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getPointStyle_doc
"Accessor to the point style of the drawable element.
Returns
-------
pointStyle : str
Style of the points within the drawable element. Use
:meth:GetValidPointStyles for a list of available values.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().getPointStyle())
none"
%enddef
%feature("docstring") OT::DrawableImplementation::getPointStyle
OT_Drawable_getPointStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setPointStyle_doc
"Accessor to the point style of the drawable element.
Parameters
----------
pointStyle : str
Style of the points within the drawable element. Use
:meth:`GetValidPointStyles` for a list of available values."
%enddef
%feature("docstring") OT::DrawableImplementation::setPointStyle
OT_Drawable_setPointStyle_doc
// ---------------------------------------------------------------------
%define OT_Drawable_GetValidPointStyles_doc
"Return the list of the valid point styles of the drawable element.
Returns
-------
validPointStyles : :class:`~openturns.Description`
List of the valid point styles of the drawable element.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().GetValidPointStyles()[:5])
[bullet,circle,diamond,dot,fcircle]"
%enddef
%feature("docstring") OT::DrawableImplementation::GetValidPointStyles
OT_Drawable_GetValidPointStyles_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getPointCode_doc
"Accessor to the code of the points style.
Parameters
----------
pointStyle : str
Style point to be changed in code.
Returns
-------
code : int
Code of the style of the points within the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::getPointCode
OT_Drawable_getPointCode_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getLabels_doc
"Accessor to the labels of data.
Returns
-------
labels : :class:`~openturns.Description`
Describes the data within the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::getLabels
OT_Drawable_getLabels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setLabels_doc
"Accessor to the labels of data.
Parameters
----------
labels : sequence of str
Describes the data within the drawable element."
%enddef
%feature("docstring") OT::DrawableImplementation::setLabels
OT_Drawable_setLabels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getDrawLabels_doc
"Accessor to the indication of data labels' presence within the drawable element.
Returns
-------
drawLabels : bool
*True* to draw the data labels, *False* to hide them."
%enddef
%feature("docstring") OT::DrawableImplementation::getDrawLabels
OT_Drawable_getDrawLabels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setDrawLabels_doc
"Accessor to the indication of data labels' presence within the drawable element.
Parameters
----------
drawLabels : bool
*True* to draw the data labels, *False* to hide them."
%enddef
%feature("docstring") OT::DrawableImplementation::setDrawLabels
OT_Drawable_setDrawLabels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getX_doc
"Accessor to the first coordinate.
Returns
-------
firstCoord : :class:`~openturns.NumericalSample`
Values of the first coordinate."
%enddef
%feature("docstring") OT::DrawableImplementation::getX
OT_Drawable_getX_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setX_doc
"Accessor to the first coordinate.
Parameters
----------
firstCoord : 2-d sequence of float
Values of the first coordinate."
%enddef
%feature("docstring") OT::DrawableImplementation::setX
OT_Drawable_setX_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getY_doc
"Accessor to the second coordinate.
Returns
-------
secondCoord : :class:`~openturns.NumericalSample`
Values of the second coordinate."
%enddef
%feature("docstring") OT::DrawableImplementation::getY
OT_Drawable_getY_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setY_doc
"Accessor to the second coordinate.
Parameters
----------
secondCoord : 2-d sequence of float
Values of the second coordinate."
%enddef
%feature("docstring") OT::DrawableImplementation::setY
OT_Drawable_setY_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getData_doc
"Accessor to the data from which the Drawable is built.
Returns
-------
data : :class:`~openturns.NumericalSample`
Data from which the Drawable is built."
%enddef
%feature("docstring") OT::DrawableImplementation::getData
OT_Drawable_getData_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getBoundingBox_doc
"Accessor to the bounding box of the whole plot.
Returns
-------
boundingBox : :class:`~openturns.NumericalPoint` of dimension 4
Bounding box of the drawable element, which is a rectangle determined
by its range along X and its range along Y.
The *boundingBox* is :math:`(x_{min}, x_{max}, y_{min}, y_{max})`."
%enddef
%feature("docstring") OT::DrawableImplementation::getBoundingBox
OT_Drawable_getBoundingBox_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getCenter_doc
"Accessor to the center of the Pie inside the bounding box.
Returns
-------
center : :class:`~openturns.NumericalPoint`
Center of the :class:`~openturns.Pie` inside the bounding box."
%enddef
%feature("docstring") OT::DrawableImplementation::getCenter
OT_Drawable_getCenter_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setCenter_doc
"Accessor to the center of the Pie inside the bounding box.
Parameters
----------
center : sequence of float
Center of the :class:`~openturns.Pie` inside the bounding box."
%enddef
%feature("docstring") OT::DrawableImplementation::setCenter
OT_Drawable_setCenter_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getRadius_doc
"Accessor to the radius of the Pie.
Returns
-------
radius : float
Radius of the :class:`~openturns.Pie`."
%enddef
%feature("docstring") OT::DrawableImplementation::getRadius
OT_Drawable_getRadius_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setRadius_doc
"Accessor to the radius of the Pie.
Parameters
----------
radius : float
Radius of the :class:`~openturns.Pie`."
%enddef
%feature("docstring") OT::DrawableImplementation::setRadius
OT_Drawable_setRadius_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getOrigin_doc
"Accessor to the origin of the BarPlot.
Returns
-------
origin : float
Value where the :class:`~openturns.BarPlot` begins."
%enddef
%feature("docstring") OT::DrawableImplementation::getOrigin
OT_Drawable_getOrigin_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setOrigin_doc
"Accessor to the origin of the BarPlot.
Parameters
----------
origin : float
Value where the :class:`~openturns.BarPlot` begins."
%enddef
%feature("docstring") OT::DrawableImplementation::setOrigin
OT_Drawable_setOrigin_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getLevels_doc
"Accessor to the levels of the Contour.
Returns
-------
levels : :class:`~openturns.NumericalPoint`
Different levels where the iso-curves of the :class:`~openturns.Contour`
will be drawn."
%enddef
%feature("docstring") OT::DrawableImplementation::getLevels
OT_Drawable_getLevels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setLevels_doc
"Accessor to the levels of the Contour.
Parameters
----------
levels : sequence of float
Different levels where the iso-curves of the :class:`~openturns.Contour`
will be drawn."
%enddef
%feature("docstring") OT::DrawableImplementation::setLevels
OT_Drawable_setLevels_doc
// ---------------------------------------------------------------------
%define OT_Drawable_getPattern_doc
"Accessor to the pattern of the Staircase.
Returns
-------
pattern : str
Pattern of the :class:`~openturns.Staircase` which is 'S' or 's'.
By default the pattern is equal to 's'. Going from :math:`(x_1, y_1)`
to :math:`(x_2, y_2)` with :math:`x_1<x_2`, pattern='s' moves first
horizontal then vertical, whereas pattern='S' moves the other way around."
%enddef
%feature("docstring") OT::DrawableImplementation::getPattern
OT_Drawable_getPattern_doc
// ---------------------------------------------------------------------
%define OT_Drawable_setPattern_doc
"Accessor to the pattern of the Staircase.
Parameters
----------
pattern : str
Pattern of the :class:`~openturns.Staircase` which is 'S' or 's'.
By default the pattern is equal to 's'. Going from :math:`(x_1, y_1)`
to :math:`(x_2, y_2)` with :math:`x_1<x_2`, pattern='s' moves first
horizontal then vertical, whereas pattern='S' moves the other way around."
%enddef
%feature("docstring") OT::DrawableImplementation::setPattern
OT_Drawable_setPattern_doc
// ---------------------------------------------------------------------
%define OT_Drawable_draw_doc
"Generate R command for plotting through R.
Returns
-------
command : str
R command used mainly by the draw method of :class:`~openturns.Graph`."
%enddef
%feature("docstring") OT::DrawableImplementation::draw
OT_Drawable_draw_doc
// ---------------------------------------------------------------------
%define OT_Drawable_clean_doc
"Clean all the temporary data created by :meth:`draw` method."
%enddef
%feature("docstring") OT::DrawableImplementation::clean
OT_Drawable_clean_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromHSV_doc
"Convert an HSV triplet to a valid hexadecimal code.
Parameters
----------
hue : float
Hue.
saturation : float
Saturation.
value : float
Value.
Returns
-------
code : str
Hexadecimal code of the color."
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromHSV
OT_Drawable_ConvertFromHSV_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromHSVA_doc
"Convert an HSVA quadruplet to a valid hexadecimal code.
Parameters
----------
hue : float
Hue.
saturation : float
Saturation.
value : float
Value.
alpha : float
Alpha component.
Returns
-------
code : str
Hexadecimal code of the color."
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromHSVA
OT_Drawable_ConvertFromHSVA_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromHSVIntoRGB_doc
"Convert an HSV triplet into an RGB triplet.
Parameters
----------
hue : float
Hue.
saturation : float
Saturation.
value : float
Value.
Returns
-------
RGBComponents : :class:`~openturns.NumericalPoint`
RGB (Red, Green and Blue) components of the color."
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromHSVIntoRGB
OT_Drawable_ConvertFromHSVIntoRGB_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromRGB_doc
"Convert an RGB triplet to a valid hexadecimal code.
Parameters
----------
red, green and blue : either three nonnegative integers or three nonnegative floats
These values are the Red, Green and Blue components of a color, a value
of 0 (or 0.0) meaning that the component is absent in the color, a value
of 255 (or 1.0) meaning that the component is fully saturated.
Returns
-------
code : str
Hexadecimal code of the color.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().ConvertFromRGB(255,0,0))
#ff0000"
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromRGB
OT_Drawable_ConvertFromRGB_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromRGBA_doc
"Convert an RGBA quadruplet to a valid hexadecimal code.
Parameters
----------
red, green and blue : either three nonnegative integers or three nonnegative floats
These values are the Red, Green and Blue components of a color, a value
of 0 (or 0.0) meaning that the component is absent in the color, a value
of 255 (or 1.0) meaning that the component is fully saturated.
alpha : either nonnegative integer or nonnegative float
Level of the color's transparency, 0 (or 0.0) meaning that the color is
fully transparent and 255 (or 1.0) meaning that the color is fully opaque.
The alpha channel is only supported by a few devices, namely the PDF and
PNG formats, for the other format the color is fully transparent as soon as
its alpha channel is less than 255 (or 1.0).
Returns
-------
code : str
Hexadecimal code of the color.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().ConvertFromRGBA(255,0,0,255))
#ff0000ff"
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromRGBA
OT_Drawable_ConvertFromRGBA_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertFromName_doc
"Convert a color name to a valid hexadecimal code.
Parameters
----------
name : str
Name of the color. The valid color names are given by the
:meth:`GetValidColors` method.
Returns
-------
code : str
Hexadecimal code of the color.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().ConvertFromName('red'))
#FF0000"
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertFromName
OT_Drawable_ConvertFromName_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertToRGB_doc
"Convert an hexadecimal code into an RGB triplet.
Parameters
----------
code : str
Hexadecimal code of the color.
Returns
-------
RGBComponents : :class:`~openturns.Indices`
List containing the RGB (Red, Green and Blue) components of the color.
A value of 0 meaning that the component is absent in the color, a value
of 255 meaning that the component is fully saturated.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().ConvertToRGB('#ff0000'))
[255,0,0]"
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertToRGB
OT_Drawable_ConvertToRGB_doc
// ---------------------------------------------------------------------
%define OT_Drawable_ConvertToRGBA_doc
"Convert an hexadecimal code into an RGBA quadruplet.
Parameters
----------
code : str
Hexadecimal code of the color.
Returns
-------
RGBAComponents : :class:`~openturns.Indices`
List containing the RGB (Red, Green and Blue) components. A value of 0
meaning that the component is absent in the color, a value of 255 meaning
that the component is fully saturated. It contains also alpha, the
level of transparency of the color. Alpha equal to 0 meaning that the
color is fully transparent and 255 meaning that the color is fully opaque.
Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable().ConvertToRGBA('#ff0000'))
[255,0,0,255]"
%enddef
%feature("docstring") OT::DrawableImplementation::ConvertToRGBA
OT_Drawable_ConvertToRGBA_doc
|