pyhelios.WeberPennTree.WeberPennTreeParameters Class Reference

Architectural parameters of a Weber-Penn tree, mirroring the C++ WeberPennTreeParameters struct. More...

Detailed Description

Architectural parameters of a Weber-Penn tree, mirroring the C++ WeberPennTreeParameters struct.

Field names and meanings are identical to the C++ struct and to the tags of the XML tree library (see the "Creating Custom XML Files" section of the plugin documentation). Per-level arrays (nSegSplits ... nBranches) are indexed by recursion level (0 = trunk) and must hold at least Levels + 1 entries. leafAngleCDF is the cumulative leaf inclination distribution computed from the XML LeafAngleDist tag (empty means uniform). Float values are stored as 32-bit floats natively.

The usual way to obtain one is :meth:WeberPennTree.getTreeParameters, modify it, and pass it to :meth:WeberPennTree.setTreeParameters.

Definition at line 186 of file WeberPennTree.py.

Collaboration diagram for pyhelios.WeberPennTree.WeberPennTreeParameters:

Public Member Functions
	__eq__ (self, other)
None	validate (self)
	Check field types, ranges and per-level array lengths.

Static Public Attributes
str	label = ''
int	Shape = 0
float	BaseSize = 0.0
float	BaseSizeV = 0.0
int	BaseSplits = 0
int	BaseSplitsV = 0
float	BaseSplitSize = 0.0
float	BaseSplitSizeV = 0.0
float	Scale = 0.0
float	ScaleV = 0.0
float	ZScale = 0.0
float	ZScaleV = 0.0
float	Ratio = 0.0
float	RatioPower = 0.0
int	Lobes = 0
float	LobeDepth = 0.0
float	Flare = 0.0
int	Levels = 0
List	nSegSplits = field(default_factory=list)
List	nSplitAngle = field(default_factory=list)
List	nSplitAngleV = field(default_factory=list)
List	nCurveRes = field(default_factory=list)
List	nCurve = field(default_factory=list)
List	nCurveV = field(default_factory=list)
List	nCurveBack = field(default_factory=list)
List	nLength = field(default_factory=list)
List	nLengthV = field(default_factory=list)
List	nTaper = field(default_factory=list)
List	nDownAngle = field(default_factory=list)
List	nDownAngleV = field(default_factory=list)
List	nRotate = field(default_factory=list)
List	nRotateV = field(default_factory=list)
List	nBranches = field(default_factory=list)
str	LeafFile = ''
int	Leaves = 0
int	LeafShape = 0
float	LeafScale = 0.0
float	LeafScaleX = 0.0
RGBcolor	WoodColor = field(default_factory=lambda: RGBcolor(0.4, 0.2, 0.05))
str	WoodFile = 'none'
List	leafAngleCDF = field(default_factory=list)

Protected Member Functions
dict	_to_wrapper_fields (self)
'WeberPennTreeParameters'	_from_wrapper_fields (cls, dict raw)

Member Function Documentation

__eq__()

pyhelios.WeberPennTree.WeberPennTreeParameters.__eq__	(		self,
			other )

Definition at line 229 of file WeberPennTree.py.

_from_wrapper_fields()

'WeberPennTreeParameters' pyhelios.WeberPennTree.WeberPennTreeParameters._from_wrapper_fields ( cls, dict raw )

protected

Definition at line 250 of file WeberPennTree.py.

_to_wrapper_fields()

dict pyhelios.WeberPennTree.WeberPennTreeParameters._to_wrapper_fields ( self )

protected

Definition at line 244 of file WeberPennTree.py.

validate()

None pyhelios.WeberPennTree.WeberPennTreeParameters.validate

(

self

)

Check field types, ranges and per-level array lengths.

Exceptions

ValueError

If any field has the wrong type, is out of range, or a per-level array is too short.

Definition at line 264 of file WeberPennTree.py.

Member Data Documentation

BaseSize

float pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSize = 0.0

static

Definition at line 189 of file WeberPennTree.py.

BaseSizeV

float pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSizeV = 0.0

static

Definition at line 190 of file WeberPennTree.py.

BaseSplits

int pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSplits = 0

static

Definition at line 191 of file WeberPennTree.py.

BaseSplitSize

float pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSplitSize = 0.0

static

Definition at line 193 of file WeberPennTree.py.

BaseSplitSizeV

float pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSplitSizeV = 0.0

static

Definition at line 194 of file WeberPennTree.py.

BaseSplitsV

int pyhelios.WeberPennTree.WeberPennTreeParameters.BaseSplitsV = 0

static

Definition at line 192 of file WeberPennTree.py.

Flare

float pyhelios.WeberPennTree.WeberPennTreeParameters.Flare = 0.0

static

Definition at line 203 of file WeberPennTree.py.

label

str pyhelios.WeberPennTree.WeberPennTreeParameters.label = ''

static

Definition at line 187 of file WeberPennTree.py.

leafAngleCDF

List pyhelios.WeberPennTree.WeberPennTreeParameters.leafAngleCDF = field(default_factory=list)

static

Definition at line 227 of file WeberPennTree.py.

LeafFile

str pyhelios.WeberPennTree.WeberPennTreeParameters.LeafFile = ''

static

Definition at line 220 of file WeberPennTree.py.

LeafScale

float pyhelios.WeberPennTree.WeberPennTreeParameters.LeafScale = 0.0

static

Definition at line 223 of file WeberPennTree.py.

LeafScaleX

float pyhelios.WeberPennTree.WeberPennTreeParameters.LeafScaleX = 0.0

static

Definition at line 224 of file WeberPennTree.py.

LeafShape

int pyhelios.WeberPennTree.WeberPennTreeParameters.LeafShape = 0

static

Definition at line 222 of file WeberPennTree.py.

Leaves

int pyhelios.WeberPennTree.WeberPennTreeParameters.Leaves = 0

static

Definition at line 221 of file WeberPennTree.py.

Levels

int pyhelios.WeberPennTree.WeberPennTreeParameters.Levels = 0

static

Definition at line 204 of file WeberPennTree.py.

LobeDepth

float pyhelios.WeberPennTree.WeberPennTreeParameters.LobeDepth = 0.0

static

Definition at line 202 of file WeberPennTree.py.

Lobes

int pyhelios.WeberPennTree.WeberPennTreeParameters.Lobes = 0

static

Definition at line 201 of file WeberPennTree.py.

nBranches

List pyhelios.WeberPennTree.WeberPennTreeParameters.nBranches = field(default_factory=list)

static

Definition at line 219 of file WeberPennTree.py.

nCurve

List pyhelios.WeberPennTree.WeberPennTreeParameters.nCurve = field(default_factory=list)

static

Definition at line 209 of file WeberPennTree.py.

nCurveBack

List pyhelios.WeberPennTree.WeberPennTreeParameters.nCurveBack = field(default_factory=list)

static

Definition at line 211 of file WeberPennTree.py.

nCurveRes

List pyhelios.WeberPennTree.WeberPennTreeParameters.nCurveRes = field(default_factory=list)

static

Definition at line 208 of file WeberPennTree.py.

nCurveV

List pyhelios.WeberPennTree.WeberPennTreeParameters.nCurveV = field(default_factory=list)

static

Definition at line 210 of file WeberPennTree.py.

nDownAngle

List pyhelios.WeberPennTree.WeberPennTreeParameters.nDownAngle = field(default_factory=list)

static

Definition at line 215 of file WeberPennTree.py.

nDownAngleV

List pyhelios.WeberPennTree.WeberPennTreeParameters.nDownAngleV = field(default_factory=list)

static

Definition at line 216 of file WeberPennTree.py.

nLength

List pyhelios.WeberPennTree.WeberPennTreeParameters.nLength = field(default_factory=list)

static

Definition at line 212 of file WeberPennTree.py.

nLengthV

List pyhelios.WeberPennTree.WeberPennTreeParameters.nLengthV = field(default_factory=list)

static

Definition at line 213 of file WeberPennTree.py.

nRotate

List pyhelios.WeberPennTree.WeberPennTreeParameters.nRotate = field(default_factory=list)

static

Definition at line 217 of file WeberPennTree.py.

nRotateV

List pyhelios.WeberPennTree.WeberPennTreeParameters.nRotateV = field(default_factory=list)

static

Definition at line 218 of file WeberPennTree.py.

nSegSplits

List pyhelios.WeberPennTree.WeberPennTreeParameters.nSegSplits = field(default_factory=list)

static

Definition at line 205 of file WeberPennTree.py.

nSplitAngle

List pyhelios.WeberPennTree.WeberPennTreeParameters.nSplitAngle = field(default_factory=list)

static

Definition at line 206 of file WeberPennTree.py.

nSplitAngleV

List pyhelios.WeberPennTree.WeberPennTreeParameters.nSplitAngleV = field(default_factory=list)

static

Definition at line 207 of file WeberPennTree.py.

nTaper

List pyhelios.WeberPennTree.WeberPennTreeParameters.nTaper = field(default_factory=list)

static

Definition at line 214 of file WeberPennTree.py.

Ratio

float pyhelios.WeberPennTree.WeberPennTreeParameters.Ratio = 0.0

static

Definition at line 199 of file WeberPennTree.py.

RatioPower

float pyhelios.WeberPennTree.WeberPennTreeParameters.RatioPower = 0.0

static

Definition at line 200 of file WeberPennTree.py.

Scale

float pyhelios.WeberPennTree.WeberPennTreeParameters.Scale = 0.0

static

Definition at line 195 of file WeberPennTree.py.

ScaleV

float pyhelios.WeberPennTree.WeberPennTreeParameters.ScaleV = 0.0

static

Definition at line 196 of file WeberPennTree.py.

Shape

int pyhelios.WeberPennTree.WeberPennTreeParameters.Shape = 0

static

Definition at line 188 of file WeberPennTree.py.

WoodColor

pyhelios.WeberPennTree.WeberPennTreeParameters.WoodColor = field(default_factory=lambda: RGBcolor(0.4, 0.2, 0.05))

static

Definition at line 225 of file WeberPennTree.py.

WoodFile

str pyhelios.WeberPennTree.WeberPennTreeParameters.WoodFile = 'none'

static

Definition at line 226 of file WeberPennTree.py.

ZScale

float pyhelios.WeberPennTree.WeberPennTreeParameters.ZScale = 0.0

static

Definition at line 197 of file WeberPennTree.py.

ZScaleV

float pyhelios.WeberPennTree.WeberPennTreeParameters.ZScaleV = 0.0

static

Definition at line 198 of file WeberPennTree.py.

---

The documentation for this class was generated from the following file:

• pyhelios/WeberPennTree.py