Skip to content

Module pytools4dart.core_ui.water

Classes

createDartFile

class createDartFile(
    version='5.10.2',
    build_='0',
    Water=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Tag_strip_pattern_
Water
build_
member_data_items_
subclass
superclass
tzoff_pattern
version

Class methods

Instance variables

Water
build_
version

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Ellipse2D

class create_Ellipse2D(
    Point2D=None,
    HalfAxes=None
)

Ellipse2D Ellipse2D

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

HalfAxes
Point2D
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

HalfAxes
Point2D

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_HalfAxes

class create_HalfAxes(
    x=9.0,
    y=7.0
)

HalfAxes HalfAxes Length (m) along x of the half axis of the ellipse that simulates the lake Length (m) along x of the half axis of the ellipse that simulates the lake Length (m) along y of the half axis of the ellipse that simulates the lake Length (m) along y of the half axis of the ellipse that simulates the lake

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
x
y

Class methods

Instance variables

x
y

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Lake

class create_Lake(
    isDisplayed=1,
    hidden=0,
    hideRB=0,
    Ellipse2D=None,
    OpticalPropertyLink=None,
    ThermalPropertyLink=None
)

Lake Lake Objects's positions are taken from the position file. Desactivate this option if you experience some slowdown. Objects's positions are taken from the position file. Desactivate this option if you experience some slowdown. If you select this option, this lake are not use in all DART modules, it's useful if you want conserve lake properties backup without delete this for tests If you select this option, this lake are not use in all DART modules, it's useful if you want conserve lake properties backup without delete this for tests Do not compute radiative budget for this object Do not compute radiative budget for this object

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Ellipse2D
OpticalPropertyLink
Tag_strip_pattern_
ThermalPropertyLink
hidden
hideRB
isDisplayed
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Ellipse2D
OpticalPropertyLink
ThermalPropertyLink
hidden
hideRB
isDisplayed

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Lakes

class create_Lakes(
    Lake=None
)

Lakes Lakes

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Lake
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Lake

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str
class create_OpticalPropertyLink(
    type_=0,
    indexFctPhase=0,
    ident='Lambertian_Phase_Function_1'
)

OpticalPropertyLink OpticalPropertyLink Type of phase function (lambertian, etc.). Water is an opaque surface. Type of phase function (lambertian, etc.). Water is an opaque surface. Index of the DART phase function of the ground of the plot. Index of the DART phase function of the ground of the plot. proportion of photons intercepted along an incident direction that are scattered within a solid angle along a given direction proportion of photons intercepted along an incident direction that are scattered within a solid angle along a given direction

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Tag_strip_pattern_
ident
indexFctPhase
member_data_items_
subclass
superclass
type_
tzoff_pattern

Class methods

Instance variables

ident
indexFctPhase
type_

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Path2D

class create_Path2D(
    width=1.5,
    Point2D=None
)

Path2D Path2D interpolation). interpolation).

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Point2D
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
width

Class methods

Instance variables

Point2D
width

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Point2D

class create_Point2D(
    x=10.0,
    y=30.0
)

Point2D Point2D x coordinate of the center of the ellipse that simulates the lake x coordinate of the center of the ellipse that simulates the lake y coordinate of the center of the ellipse that simulates the lake y coordinate of the center of the ellipse that simulates the lake

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
x
y

Class methods

Instance variables

x
y

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_River

class create_River(
    isDisplayed=1,
    hidden=0,
    hideRB=0,
    Path2D=None,
    OpticalPropertyLink=None,
    ThermalPropertyLink=None
)

River River Objects's positions are taken from the position file. Desactivate this option if you experience some slowdown. Objects's positions are taken from the position file. Desactivate this option if you experience some slowdown. If you select this option, this river are not use in all DART modules, it's useful if you want conserve river properties backup without delete this for tests If you select this option, this river are not use in all DART modules, it's useful if you want conserve river properties backup without delete this for tests Do not compute radiative budget for this object Do not compute radiative budget for this object

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

OpticalPropertyLink
Path2D
Tag_strip_pattern_
ThermalPropertyLink
hidden
hideRB
isDisplayed
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

OpticalPropertyLink
Path2D
ThermalPropertyLink
hidden
hideRB
isDisplayed

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Rivers

class create_Rivers(
    River=None
)

Rivers Rivers

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

River
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

River

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str
class create_ThermalPropertyLink(
    indexTemperature=0,
    idTemperature='Temperature_290_310'
)

ThermalPropertyLink ThermalPropertyLink indexTemperature indexTemperature Thermal Function ID Thermal Function ID

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Tag_strip_pattern_
idTemperature
indexTemperature
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

idTemperature
indexTemperature

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str

create_Water

class create_Water(
    waterPriorityOnTrees=0,
    waterPriorityOnPlots=0,
    Lakes=None,
    Rivers=None
)

Water Water Water "scratches/replaces" trees Water "scratches/replaces" trees Water "scratches/replaces" plots Water "scratches/replaces" plots

Ancestors (in MRO)

  • pytools4dart.core_ui.water.GeneratedsSuper

Class variables

Lakes
Rivers
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
waterPriorityOnPlots
waterPriorityOnTrees

Class methods

Instance variables

Lakes
Rivers
waterPriorityOnPlots
waterPriorityOnTrees

Methods

path
def path(
    self,
    index=True
)
Get the dartnode path of the corenode
Parameters
----------
corenode: object
    a core object

index: bool

    If True gets the dartnode path with index if list,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction[0]'

    If False gets the dartnode path without index,
    e.g. 'Coeff_diff.AirMultiFunctions.AirFunction'

Returns
-------
    str