trescope.config ¶

Contents

Config
Config Miscs
- ScatterSymbol
- ScatterMode

Config ¶

AxisHelper3DConfig ¶

class trescope.config. AxisHelper3DConfig [source] ¶

Config for trescope.Output.plotAxisHelper3D()

axisLength ( axisLength : float ) [source] ¶

Axis length .

Parameters: axisLength – axisLength , default 1
Returns: self , for chain call

width ( width : float ) [source] ¶

Axis line width .

Parameters: width – width , default 1
Returns: self , for chain call

FRONT3DConfig ¶

class trescope.config. FRONT3DConfig [source] ¶

Config for trescope.Output.plotFRONT3D()

baseLightStrength ( strength : float ) [source] ¶

Specify base light strength .

Parameters: strength – light strength , default 10
Returns: self , for chain call

hiddenMeshes ( hiddenMeshes : List [ str ] ) [source] ¶

Specify hidden meshes .

Parameters: hiddenMeshes – types of mesh to hide
Returns: self , for chain call

renderType ( renderType : str ) [source] ¶

Specify render type , enumeration of color , depth and normal .

Parameters: renderType – render type , default color
Returns: self , for chain call

renderer ( renderer : str , sampleCount : int = 128 ) [source] ¶

Specify renderer , enumeration of default and blender . blender renderer only works , if blender has been installed .

Parameters

renderer – renderer , default default
sampleCount – sample count , matters when blender renderer used

Returns

self , for chain call

shapeLocalSource ( shapeLocalSource : str ) [source] ¶

Specify directory where model files ( *.obj and *.png , referenced by front3d json file) put .

Parameters: shapeLocalSource – directory where model files ( *.obj and *.png , referenced by front3d json file) put
Returns: self , for chain call

unit ( unit : str ) [source] ¶

Specify unit , m or cm .

Parameters: unit – unit , default m
Returns: self , for chain call

view ( view : str ) [source] ¶

Specify view , enumeration of top , bottom , left , right , back and front or None . If view is specified , trescope.Layout.camera() won’t work .

Parameters: view – enumeration of top , bottom , left , right , back and front or None
Returns: self , for chain call

GraphConfig ¶

class trescope.config. GraphConfig [source] ¶

Config for trescope.Output.plotGraph()

edgeColor ( edgeColor ) [source] ¶

Specify edge color .

Parameters: edgeColor – edge color
Returns: self , for chain call

edgeDescription ( edgeDescription ) [source] ¶

Specify edge description .

Parameters: edgeDescription – edge description
Returns: self , for chain call

edgeOpacity ( edgeOpacity ) [source] ¶

Specify edgeOpacity opacity .

Parameters: edgeOpacity – edge opacity
Returns: self , for chain call

edgeWidth ( edgeWidth ) [source] ¶

Specify edge width .

Parameters: edgeWidth – edge width
Returns: self , for chain call

vertexColor ( vertexColor ) [source] ¶

Specify vertex color .

Parameters: vertexColor – vertex color
Returns: self , for chain call

vertexDescription ( vertexDescription ) [source] ¶

Specify vertex description .

Parameters: vertexDescription – vertex description
Returns: self , for chain call

vertexOpacity ( vertexOpacity ) [source] ¶

Specify vertex opacity .

Parameters: vertexOpacity – vertex opacity
Returns: self , for chain call

vertexSize ( vertexSize ) [source] ¶

Specify vertex size .

Parameters: vertexSize – vertex size
Returns: self , for chain call

HeatMapConfig ¶

class trescope.config. HeatMapConfig [source] ¶

Config for trescope.Output.plotHeatMap()

colorScale ( colorScale : str ) [source] ¶

Specify color scale .

Parameters: colorScale – color scale , default RdBu
Returns: self , for chain call

useGL ( useGL : bool ) [source] ¶

Specify use gl or not .

Parameters: useGL – use gl , default False
Returns: self , for chain call

HistogramConfig ¶

class trescope.config. HistogramConfig [source] ¶

Config for trescope.Output.plotHistogram()

color ( color : int ) [source] ¶

Specify color .

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

xBinRange ( start : float , end : float , step : float ) [source] ¶

Specify x bin range .

Parameters

start – bin start
end – bin end
step – bin step

Returns

self , for chain call

ImageConfig ¶

class trescope.config. ImageConfig [source] ¶: Config for trescope.Output.plotImage()

LineSegmentConfig ¶

class trescope.config. LineSegmentConfig [source] ¶

Config for trescope.Output.plotLineSegment()

color ( color : int ) [source] ¶

Specify line color .

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

indices ( i : List [ int ] , j : List [ int ] ) [source] ¶

Specify indices of vertices to form line segments .

Parameters

i – i
j – j

Returns

self , for chain call

width ( width : int ) [source] ¶

Specify line width .

Parameters: width – width , default 1
Returns: self , for chain call

Lollipop3DConfig ¶

class trescope.config. Lollipop3DConfig [source] ¶

Config for trescope.Output.plotLollipop3D()

color ( color : int ) [source] ¶

Specify color .

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

headSize ( size : float ) [source] ¶

Specify head size .

Parameters: size – size , default 10
Returns: self , for chain call

lineWidth ( width : float ) [source] ¶

Specify line width .

Parameters: width – width , default 1
Returns: self , for chain call

locations ( x : List [ float ] , y : List [ float ] , z : List [ float ] ) [source] ¶

Specify locations .

Parameters

x – x
y – y
z – z

Returns

self , for chain call

tailSize ( size : float ) [source] ¶

Specify tail size .

Parameters: size – size , default 20
Returns: self , for chain call

Mesh3DConfig ¶

class trescope.config. Mesh3DConfig [source] ¶

Config for trescope.Output.plotMesh3D()

color ( color : int ) [source] ¶

Specify color of whole mesh . If trescope.config.Mesh3DConfig.faceColor() has specified , it won’t work.

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

faceColor ( color : Optional [ List [ int ] ] ) [source] ¶

Specify colors of faces separately .

Parameters: color – color array , default None
Returns: self , for chain call

flatShading ( flatShading : bool ) [source] ¶

Specify flat shading .

Parameters: flatShading – flat shading , default False
Returns

indices ( i : List [ int ] , j : List [ int ] , k : List [ int ] ) [source] ¶

Specify indices of vertices to form faces .

Parameters

i – i
j – j
k – k

Returns

self , for chain call

texture ( uri : str , autoFlip : bool = True , wrap : Tuple [ str , str ] = ('CLAMP_TO_EDGE', 'CLAMP_TO_EDGE') ) [source] ¶

Specify texture .

Parameters

uri – texture uri , local file path or url .
autoFlip – flip texture or not , default True
wrap – wrap , enumeration of CLAMP_TO_EDGE and REPEAT , default CLAMP_TO_EDGE

Returns

self , for chain call

textureCoordinate ( u : Union [ List [ float ] , numpy.ndarray ] , v : List [ float ] ) [source] ¶

Specify texture coordinates .

Parameters

u – u
v – v

Returns

self , for chain call

PieConfig ¶

class trescope.config. PieConfig [source] ¶: Config for trescope.Output.plotPie()

Scatter2DConfig ¶

class trescope.config. Scatter2DConfig [source] ¶

Config for trescope.Output.plotScatter2D()

color ( color : int ) [source] ¶

Specify color .

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

fill ( fill : bool ) [source] ¶

Specify fill or not .

Parameters: fill – fill , default False
Returns: self , for chain call

fillColor ( color : int ) [source] ¶

Specify fill color .

Parameters: color – color , default 0x88000000 (means black with transparency of 0x88)
Returns: self , for chain call

mode ( modeCombination : List [ str ] ) [source] ¶

Specify mode , enumeration of trescope.config.ScatterMode.MARKERS , trescope.config.ScatterMode.LINES or combination of them .

Parameters: modeCombination – combination of mode , default [trescope.config.ScatterMode.MARKERS]
Returns: self , for chain call

size ( size : float ) [source] ¶

Specify size .

Parameters: size – size , default 5
Returns: self , for chain call

symbol ( symbolOrSymbols ) [source] ¶

Specify symbol .

Parameters: symbolOrSymbols – symbol , see trescope.config.ScatterSymbol , default trescope.config.ScatterSymbol.Circle
Returns: self , for chain call

useGL ( useGL : bool ) [source] ¶

Specify use gl or not .

Parameters: useGL – use gl , default False
Returns: self , for chain call

Scatter3DConfig ¶

class trescope.config. Scatter3DConfig [source] ¶

Config for trescope.Output.plotScatter3D()

color ( color : Union [ int , List [ int ] ] ) [source] ¶

Specify color .

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

mode ( modeCombination : List [ str ] ) [source] ¶

Specify mode , enumeration of trescope.config.ScatterMode.MARKERS , trescope.config.ScatterMode.LINES or combination of them .

Parameters: modeCombination – combination of mode , default [trescope.config.ScatterMode.MARKERS]
Returns: self , for chain call

size ( size : float ) [source] ¶

Specify size .

Parameters: size – size , default 5
Returns: self , for chain call

symbol ( symbolOrSymbols ) [source] ¶

Specify symbol .

Parameters: symbolOrSymbols – symbol , see trescope.config.ScatterSymbol , default trescope.config.ScatterSymbol.Circle
Returns: self , for chain call

width ( width : float ) [source] ¶

Specify line width .

Parameters: width – width , default 1
Returns: self , for chain call

Surface3DConfig ¶

class trescope.config. Surface3DConfig [source] ¶: Config for trescope.Output.plotSurface3D()

VectorField3DConfig ¶

class trescope.config. VectorField3DConfig [source] ¶

Config for trescope.Output.plotVectorField3D()

anchor ( anchor : trescope.config.AnchorType ) [source] ¶

Specify anchor type .

Parameters: anchor – anchor
Returns: self , for chain call

autoScaleByLocation ( autoScale : bool ) [source] ¶

Specify auto scale or not .

Parameters: autoScale – auto scale , default False
Returns: self , for chain call

color ( color : int ) [source] ¶

Specify color .

Parameters: color – color
Returns: self , for chain call

locations ( x : List [ float ] , y : List [ float ] , z : List [ float ] ) [source] ¶

Specify locations .

Parameters

x – x
y – y
z – z

Returns

self , for chain call

sizeFactor ( sizeFactor : float ) [source] ¶

Specify size factor .

Parameters: sizeFactor – size factor , default .5
Returns: self , for chain call

ViolinConfig ¶

class trescope.config. ViolinConfig [source] ¶

Config for trescope.Output.plotViolin()

color ( color : int ) [source] ¶

Specify color .

Parameters: color – color , default 0xff000000 (means black with transparency of 0x88)
Returns: self , for chain call

useUniformAxis ( useUniformAxis : bool ) [source] ¶

Use uniform axis or not .

Parameters: useUniformAxis – use uniform axis , default False
Returns: self , for chain call

useUniformScale ( useUniformScale : bool ) [source] ¶

Use uniform scale or not .

Parameters: useUniformScale – use uniform scale , default False
Returns: self , for chain call

Volume3DConfig ¶

class trescope.config. Volume3DConfig [source] ¶

Config for trescope.Output.plotVolume3D()

isoMax ( isoMax : float ) [source] ¶

Specify iso max .

Parameters: isoMax – ios max , default .5
Returns: self , for chain call

isoMin ( isoMin : float ) [source] ¶

Specify iso min .

Parameters: isoMin – ios min , default -.5
Returns: self , for chain call

opacity ( opacity : float ) [source] ¶

Specify opacity .

Parameters: opacity – opacity , default .2
Returns: self , for chain call

surfaceCount ( surfaceCount : int ) [source] ¶

Specify surface count .

Parameters: surfaceCount – surface count , default 5
Returns: self , for chain call

Wireframe3DConfig ¶

class trescope.config. Wireframe3DConfig [source] ¶

Config for trescope.Output.plotWireframe3D()

color ( color : int ) [source] ¶

Specify line color of wireframe.

Parameters: color – color , default 0xff000000 (means black with no transparency)
Returns: self , for chain call

indices ( i : List [ int ] , j : List [ int ] , k : List [ int ] ) [source] ¶

Specify indices of vertices to form faces .

Parameters

i – i
j – j
k – k

Returns

self , for chain call

width ( width : int ) [source] ¶

Specify line width of wireframe .

Parameters: width – width , default 1
Returns: self , for chain call

Config Miscs ¶

ScatterSymbol ¶

class trescope.config. ScatterSymbol [source] ¶

Asterisk : str = 'asterisk' ¶: Asterisk

AsteriskOpen : str = 'asterisk-open' ¶: AsteriskOpen

Bowtie : str = 'bowtie' ¶: Bowtie

BowtieOpen : str = 'bowtie-open' ¶: BowtieOpen

Circle : str = 'circle' ¶: Circle

CircleCross : str = 'circle-cross' ¶: CircleCross

CircleCrossOpen : str = 'circle-cross-open' ¶: CircleCrossOpen

CircleDot : str = 'circle-dot' ¶: CircleDot

CircleOpen : str = 'circle-open' ¶: CircleOpen

CircleOpenDot : str = 'circle-open-dot' ¶: CircleOpenDot

CircleX : str = 'circle-x' ¶: CircleX

CircleXOpen : str = 'circle-x-open' ¶: CircleXOpen

Cross : str = 'cross' ¶: Cross

CrossDot : str = 'cross-dot' ¶: CrossDot

CrossOpen : str = 'cross-open' ¶: CrossOpen

CrossOpenDot : str = 'cross-open-dot' ¶: CrossOpenDot

CrossThin : str = 'cross-thin' ¶: CrossThin

CrossThinOpen : str = 'cross-thin-open' ¶: CrossThinOpen

Diamond : str = 'diamond' ¶: Diamond

DiamondCross : str = 'diamond-cross' ¶: DiamondCross

DiamondCrossOpen : str = 'diamond-cross-open' ¶: DiamondCrossOpen

DiamondDot : str = 'diamond-dot' ¶: DiamondDot

DiamondOpen : str = 'diamond-open' ¶: DiamondOpen

DiamondOpenDot : str = 'diamond-open-dot' ¶: DiamondOpenDot

DiamondTall : str = 'diamond-tall' ¶: DiamondTall

DiamondTallDot : str = 'diamond-tall-dot' ¶: DiamondTallDot

DiamondTallOpen : str = 'diamond-tall-open' ¶: DiamondTallOpen

DiamondTallOpenDot : str = 'diamond-tall-open-dot' ¶: DiamondTallOpenDot

DiamondWide : str = 'diamond-wide' ¶: DiamondWide

DiamondWideDot : str = 'diamond-wide-dot' ¶: DiamondWideDot

DiamondWideOpen : str = 'diamond-wide-open' ¶: DiamondWideOpen

DiamondWideOpenDot : str = 'diamond-wide-open-dot' ¶: DiamondWideOpenDot

DiamondX : str = 'diamond-x' ¶: DiamondX

DiamondXOpen : str = 'diamond-x-open' ¶: DiamondXOpen

Hash : str = 'hash' ¶: Hash

HashDot : str = 'hash-dot' ¶: HashDot

HashOpen : str = 'hash-open' ¶: HashOpen

HashOpenDot : str = 'hash-open-dot' ¶: HashOpenDot

Hexagon : str = 'hexagon' ¶: Hexagon

Hexagon2 : str = 'hexagon2' ¶: Hexagon2

Hexagon2Dot : str = 'hexagon2-dot' ¶: Hexagon2Dot

Hexagon2Open : str = 'hexagon2-open' ¶: Hexagon2Open

Hexagon2OpenDot : str = 'hexagon2-open-dot' ¶: Hexagon2OpenDot

HexagonDot : str = 'hexagon-dot' ¶: HexagonDot

HexagonOpen : str = 'hexagon-open' ¶: HexagonOpen

HexagonOpenDot : str = 'hexagon-open-dot' ¶: HexagonOpenDot

Hexagram : str = 'hexagram' ¶: Hexagram

HexagramDot : str = 'hexagram-dot' ¶: HexagramDot

HexagramOpen : str = 'hexagram-open' ¶: HexagramOpen

HexagramOpenDot : str = 'hexagram-open-dot' ¶: HexagramOpenDot

Hourglass : str = 'hourglass' ¶: Hourglass

HourglassOpen : str = 'hourglass-open' ¶: HourglassOpen

LineEw : str = 'line-ew' ¶: LineEw

LineEwOpen : str = 'line-ew-open' ¶: LineEwOpen

LineNe : str = 'line-ne' ¶: LineNe

LineNeOpen : str = 'line-ne-open' ¶: LineNeOpen

LineNs : str = 'line-ns' ¶: LineNs

LineNsOpen : str = 'line-ns-open' ¶: LineNsOpen

LineNw : str = 'line-nw' ¶: LineNw

LineNwOpen : str = 'line-nw-open' ¶: LineNwOpen

Octagon : str = 'octagon' ¶: Octagon

OctagonDot : str = 'octagon-dot' ¶: OctagonDot

OctagonOpen : str = 'octagon-open' ¶: OctagonOpen

OctagonOpenDot : str = 'octagon-open-dot' ¶: OctagonOpenDot

Pentagon : str = 'pentagon' ¶: Pentagon

PentagonDot : str = 'pentagon-dot' ¶: PentagonDot

PentagonOpen : str = 'pentagon-open' ¶: PentagonOpen

PentagonOpenDot : str = 'pentagon-open-dot' ¶: PentagonOpenDot

Square : str = 'square' ¶: Square

SquareCross : str = 'square-cross' ¶: SquareCross

SquareCrossOpen : str = 'square-cross-open' ¶: SquareCrossOpen

SquareDot : str = 'square-dot' ¶: SquareDot

SquareOpen : str = 'square-open' ¶: SquareOpen

SquareOpenDot : str = 'square-open-dot' ¶: SquareOpenDot

SquareX : str = 'square-x' ¶: SquareX

SquareXOpen : str = 'square-x-open' ¶: SquareXOpen

Star : str = 'star' ¶: Star

StarDiamond : str = 'star-diamond' ¶: StarDiamond

StarDiamondDot : str = 'star-diamond-dot' ¶: StarDiamondDot

StarDiamondOpen : str = 'star-diamond-open' ¶: StarDiamondOpen

StarDiamondOpenDot : str = 'star-diamond-open-dot' ¶: StarDiamondOpenDot

StarDot : str = 'star-dot' ¶: StarDot

StarOpen : str = 'star-open' ¶: StarOpen

StarOpenDot : str = 'star-open-dot' ¶: StarOpenDot

StarSquare : str = 'star-square' ¶: StarSquare

StarSquareDot : str = 'star-square-dot' ¶: StarSquareDot

StarSquareOpen : str = 'star-square-open' ¶: StarSquareOpen

StarSquareOpenDot : str = 'star-square-open-dot' ¶: StarSquareOpenDot

StarTriangleDown : str = 'star-triangle-down' ¶: StarTriangleDown

StarTriangleDownDot : str = 'star-triangle-down-dot' ¶: StarTriangleDownDot

StarTriangleDownOpen : str = 'star-triangle-down-open' ¶: StarTriangleDownOpen

StarTriangleDownOpenDot : str = 'star-triangle-down-open-dot' ¶: StarTriangleDownOpenDot

StarTriangleUp : str = 'star-triangle-up' ¶: StarTriangleUp

StarTriangleUpDot : str = 'star-triangle-up-dot' ¶: StarTriangleUpDot

StarTriangleUpOpen : str = 'star-triangle-up-open' ¶: StarTriangleUpOpen

StarTriangleUpOpenDot : str = 'star-triangle-up-open-dot' ¶: StarTriangleUpOpenDot

TriangleDown : str = 'triangle-down' ¶: TriangleDown

TriangleDownDot : str = 'triangle-down-dot' ¶: TriangleDownDot

TriangleDownOpen : str = 'triangle-down-open' ¶: TriangleDownOpen

TriangleDownOpenDot : str = 'triangle-down-open-dot' ¶: TriangleDownOpenDot

TriangleLeft : str = 'triangle-left' ¶: TriangleLeft

TriangleLeftDot : str = 'triangle-left-dot' ¶: TriangleLeftDot

TriangleLeftOpen : str = 'triangle-left-open' ¶: TriangleLeftOpen

TriangleLeftOpenDot : str = 'triangle-left-open-dot' ¶: TriangleLeftOpenDot

TriangleNe : str = 'triangle-ne' ¶: TriangleNe

TriangleNeDot : str = 'triangle-ne-dot' ¶: TriangleNeDot

TriangleNeOpen : str = 'triangle-ne-open' ¶: TriangleNeOpen

TriangleNeOpenDot : str = 'triangle-ne-open-dot' ¶: TriangleNeOpenDot

TriangleNw : str = 'triangle-nw' ¶: TriangleNw

TriangleNwDot : str = 'triangle-nw-dot' ¶: TriangleNwDot

TriangleNwOpen : str = 'triangle-nw-open' ¶: TriangleNwOpen

TriangleNwOpenDot : str = 'triangle-nw-open-dot' ¶: TriangleNwOpenDot

TriangleRight : str = 'triangle-right' ¶: TriangleRight

TriangleRightDot : str = 'triangle-right-dot' ¶: TriangleRightDot

TriangleRightOpen : str = 'triangle-right-open' ¶: TriangleRightOpen

TriangleRightOpenDot : str = 'triangle-right-open-dot' ¶: TriangleRightOpenDot

TriangleSe : str = 'triangle-se' ¶: TriangleSe

TriangleSeDot : str = 'triangle-se-dot' ¶: TriangleSeDot

TriangleSeOpen : str = 'triangle-se-open' ¶: TriangleSeOpen

TriangleSeOpenDot : str = 'triangle-se-open-dot' ¶: TriangleSeOpenDot

TriangleSw : str = 'triangle-sw' ¶: TriangleSw

TriangleSwDot : str = 'triangle-sw-dot' ¶: TriangleSwDot

TriangleSwOpen : str = 'triangle-sw-open' ¶: TriangleSwOpen

TriangleSwOpenDot : str = 'triangle-sw-open-dot' ¶: TriangleSwOpenDot

TriangleUp : str = 'triangle-up' ¶: TriangleUp

TriangleUpDot : str = 'triangle-up-dot' ¶: TriangleUpDot

TriangleUpOpen : str = 'triangle-up-open' ¶: TriangleUpOpen

TriangleUpOpenDot : str = 'triangle-up-open-dot' ¶: TriangleUpOpenDot

X : str = 'x' ¶: X

XDot : str = 'x-dot' ¶: XDot

XOpen : str = 'x-open' ¶: XOpen

XOpenDot : str = 'x-open-dot' ¶: XOpenDot

XThin : str = 'x-thin' ¶: XThin

XThinOpen : str = 'x-thin-open' ¶: XThinOpen

YDown : str = 'y-down' ¶: YDown

YDownOpen : str = 'y-down-open' ¶: YDownOpen

YLeft : str = 'y-left' ¶: YLeft

YLeftOpen : str = 'y-left-open' ¶: YLeftOpen

YRight : str = 'y-right' ¶: YRight

YRightOpen : str = 'y-right-open' ¶: YRightOpen

YUp : str = 'y-up' ¶: YUp

YUpOpen : str = 'y-up-open' ¶: YUpOpen

ScatterMode ¶

class trescope.config. ScatterMode [source] ¶