Skip to content

Module pytools4dart.core_ui.directions

Classes

createDartFile

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

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Directions

Tag_strip_pattern_

build_

member_data_items_

subclass

superclass

tzoff_pattern

version

Class methods

Instance variables

Directions

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_AddedDirections

class create_AddedDirections(
    imageDirection=1,
    directionType=0,
    ifSquareShape=1,
    ifPhaseOnly=0,
    ZenithAzimuth=None,
    LatLon=None,
    Rectangle=None,
    Square=None
)

If checked, images will be systematically generated in this direction, unless images production has been totally disable in the product tab. If checked, images will be systematically generated in this direction, unless images production has been totally disable in the product tab. To enter directly the angles of the direction, choose "Zenith+Azimuth". Dart is also able to automaticaly determinate the angles of a direction given the LatLon coordinates of the (theorical) sensor and the scene, while taking in account the curves of the Earth. To do this, choose "LatLon Coordinates". To enter directly the angles of the direction, choose "Zenith+Azimuth". Dart is also able to automaticaly determinate the angles of a direction given the LatLon coordinates of the (theorical) sensor and the scene, while taking in account the curves of the Earth. To do this, choose "LatLon Coordinates". The shape used to described the opening of the direction cone The shape used to described the opening of the direction cone The oversampling directions are used only in the calculation of phase functions, which in DART module, are used to increase the directional sampling for selection of instant directional phase function during scattering event. The directions are essentially virtual. The oversampling directions are used only in the calculation of phase functions, which in DART module, are used to increase the directional sampling for selection of instant directional phase function during scattering event. The directions are essentially virtual.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

LatLon

Rectangle

Square

Tag_strip_pattern_

ZenithAzimuth

directionType

ifPhaseOnly

ifSquareShape

imageDirection

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

LatLon

Rectangle

Square

ZenithAzimuth

directionType

ifPhaseOnly

ifSquareShape

imageDirection

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_AzimuthalOffset

class create_AzimuthalOffset(
    sunAzimuthalOffset=0,
    directionalAzimuthalOffset=0
)

Example: to get a 30deg scene azimuth rotation, the offsets of sun and viewing directions must be equal to 30deg Example: to get a 30deg scene azimuth rotation, the offsets of sun and viewing directions must be equal to 30deg Example: to get a 30deg scene azimuth rotation, the offsets of sun and viewing directions must be equal to 30deg Example: to get a 30deg scene azimuth rotation, the offsets of sun and viewing directions must be equal to 30deg

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

directionalAzimuthalOffset

member_data_items_

subclass

sunAzimuthalOffset

superclass

tzoff_pattern

Class methods

Instance variables

directionalAzimuthalOffset

sunAzimuthalOffset

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_BandIrradianceFileNode

class create_BandIrradianceFileNode(
    bandIrradianceFile='sunIrradiance.txt'
)

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

bandIrradianceFile

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

bandIrradianceFile

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_DefineDeltaPhi

class create_DefineDeltaPhi(
    deltaPhi=2
)

Azimuthal width of the region in the [0°, 360°] range Azimuthal width of the region in the [0°, 360°] range

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

deltaPhi

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

deltaPhi

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_DefineDeltaTheta

class create_DefineDeltaTheta(
    deltaTheta=2
)

All cells are empty at a distance less than "a x local tree crown radius" All cells are empty at a distance less than "a x local tree crown radius" Zenithal width of the region in the [0°, 180°] range Zenithal width of the region in the [0°, 180°] range

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

deltaTheta

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

deltaTheta

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_DefineOmega

class create_DefineOmega(
    omega=0.001
)

All cells are empty at a distance less than "a x local tree crown radius" All cells are empty at a distance less than "a x local tree crown radius" Solid Angle (steradians) Solid Angle (steradians)

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

omega

subclass

superclass

tzoff_pattern

Class methods

Instance variables

omega

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_Directions

class create_Directions(
    numberOfPropagationDirections=100,
    ifCosWeighted=0,
    exactDate=2,
    AddedDirections=None,
    Region=None,
    OversampledPlane=None,
    SecondaryIlluminationSource=None,
    Sun=None,
    ExactDateHour=None,
    SunViewingAngles=None,
    HotSpotProperties=None,
    Penumbra=None,
    AzimuthalOffset=None,
    ExpertModeZone=None
)

Approximate number of directions that sample the 4.Pi space. - DART- FT: radiation is tracked along these directions. - DART-LUX and DART-FT: it defines the possible viewing directions. - DART-LUX, DART-FT, DART-RC: computation of scattering phase functions Approximate number of directions that sample the 4.Pi space. - DART-FT: radiation is tracked along these directions. - DART-LUX and DART-FT: it defines the possible viewing directions. - DART- LUX, DART-FT, DART-RC: computation of scattering phase functions Cosine Weighted Cosine Weighted DART provides 3 way to indicate the sun angles: By giving the Downward Solar Angles (Sun to Ground) By giving the Viewing Solar Angle (Ground to Sun) Solar angles calculated from the localisation of the scene (longitude and latitude) and the exact (local) date (YY/MM/DD and HH/MM/SS) Note that in the last case, the computed direction will be the physical sun angle and not the apparent sun angle. I.E. it doesn't take into account the atmosphere refraction. DART provides 3 way to indicate the sun angles: By giving the Downward Solar Angles (Sun to Ground) By giving the Viewing Solar Angle (Ground to Sun) Solar angles calculated from the localisation of the scene (longitude and latitude) and the exact (local) date (YY/MM/DD and HH/MM/SS) Note that in the last case, the computed direction will be the physical sun angle and not the apparent sun angle. I.E. it doesn't take into account the atmosphere refraction.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

AddedDirections

AzimuthalOffset

ExactDateHour

ExpertModeZone

HotSpotProperties

OversampledPlane

Penumbra

Region

SecondaryIlluminationSource

Sun

SunViewingAngles

Tag_strip_pattern_

exactDate

ifCosWeighted

member_data_items_

numberOfPropagationDirections

subclass

superclass

tzoff_pattern

Class methods

Instance variables

AddedDirections

AzimuthalOffset

ExactDateHour

ExpertModeZone

HotSpotProperties

OversampledPlane

Penumbra

Region

SecondaryIlluminationSource

Sun

SunViewingAngles

exactDate

ifCosWeighted

numberOfPropagationDirections

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_ExactDateHour

class create_ExactDateHour(
    year=2012,
    month=1,
    day=1,
    hour=12,
    minute=0,
    second=0,
    localTime=0,
    timezone=0,
    daylightSavingTime=0
)

Year (From 1400 to 10 000) Year (From 1400 to 10 000) Month into the year Month into the year Day of the month Day of the month Hours into the day Hours into the day Minutes into the hour Minutes into the hour Seconds into the minute Seconds into the minute Local time Local time Local Time Zone (UTC) : if the time is given as local time, this must be the time difference with UTC. If the time is given as UTC time, this must be 0 Local Time Zone (UTC) : if the time is given as local time, this must be the time difference with UTC. If the time is given as UTC time, this must be 0 Click this if the simulated area is observing DST at the given date. Click this if the simulated area is observing DST at the given date.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

day

daylightSavingTime

hour

localTime

member_data_items_

minute

month

second

subclass

superclass

timezone

tzoff_pattern

year

Class methods

Instance variables

day

daylightSavingTime

hour

localTime

minute

month

second

timezone

year

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_ExpertModeZone

class create_ExpertModeZone(
    numberOfAngularSector=10,
    numberOfLayers=0
)

Enter the n number of angular sectors. In iterations 1, the angular distribution of intercepted radiation is stored in n angular sectors, for improving further scattering accuracy. The maximal number of sectors is the actual number of directions. The sector value of a direction is stored in the 4th column of the direction file. Enter the n number of angular sectors. In iterations 1, the angular distribution of intercepted radiation is stored in n angular sectors, for improving further scattering accuracy. The maximal number of sectors is the actual number of directions. The sector value of a direction is stored in the 4th column of the direction file. 0 for default value generated by sphere directions, or enter a positive integer for the number of layers to generate the directions in one hemisphere. 0 for default value generated by sphere directions, or enter a positive integer for the number of layers to generate the directions in one hemisphere.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

numberOfAngularSector

numberOfLayers

subclass

superclass

tzoff_pattern

Class methods

Instance variables

numberOfAngularSector

numberOfLayers

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_HotSpotDownwardRegion

class create_HotSpotDownwardRegion(
    omega=0.01,
    numberOfDirections=25
)

Region Solid Angle (steradians) Region Solid Angle (steradians) Number of directions in region. Automatically rounded to the nearest squared integer. Number of directions in region. Automatically rounded to the nearest squared integer.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

numberOfDirections

omega

subclass

superclass

tzoff_pattern

Class methods

Instance variables

numberOfDirections

omega

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_HotSpotOversampledPlane

class create_HotSpotOversampledPlane(
    deltaTheta=10.0,
    omega=0.001,
    defRange=0,
    thetaRange=None
)

Zenith step in the oversampled plane (solar plane or perpendicular to solar plane). Zenith step in the oversampled plane (solar plane or perpendicular to solar plane). Solid angle for each direction in the Hot Spot oversampled plane (in steradians). Solid angle for each direction in the Hot Spot oversampled plane (in steradians). Define Zenith Angle range Define Zenith Angle range

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

defRange

deltaTheta

member_data_items_

omega

subclass

superclass

thetaRange

tzoff_pattern

Class methods

Instance variables

defRange

deltaTheta

omega

thetaRange

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_HotSpotProperties

class create_HotSpotProperties(
    oversampleUpwardRegion=0,
    oversampleDownwardRegion=0,
    hotSpotPerpendicularPlane=0,
    hotSpotParallelPlane=0,
    HotSpotUpwardRegion=None,
    HotSpotDownwardRegion=None,
    HotSpotOversampledPlane=None
)

Adds directions around the upward hot spot direction, with very small solid angles Adds directions around the upward hot spot direction, with very small solid angles Adds directions around the downward hot spot direction, with very small solid angles Adds directions around the downward hot spot direction, with very small solid angles Oversample the plane perpendicular to the solar plane (directions with same azimuth). Oversample the plane perpendicular to the solar plane (directions with same azimuth). Oversample the solar plane (directions with sun direction azimuth). Oversample the solar plane (directions with sun direction azimuth).

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

HotSpotDownwardRegion

HotSpotOversampledPlane

HotSpotUpwardRegion

Tag_strip_pattern_

hotSpotParallelPlane

hotSpotPerpendicularPlane

member_data_items_

oversampleDownwardRegion

oversampleUpwardRegion

subclass

superclass

tzoff_pattern

Class methods

Instance variables

HotSpotDownwardRegion

HotSpotOversampledPlane

HotSpotUpwardRegion

hotSpotParallelPlane

hotSpotPerpendicularPlane

oversampleDownwardRegion

oversampleUpwardRegion

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_HotSpotUpwardRegion

class create_HotSpotUpwardRegion(
    omega=0.01,
    numberOfDirections=25
)

Region Solid Angle (steradians) Region Solid Angle (steradians) Number of directions in region. Automatically rounded to the nearest squared integer. Number of directions in region. Automatically rounded to the nearest squared integer.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

numberOfDirections

omega

subclass

superclass

tzoff_pattern

Class methods

Instance variables

numberOfDirections

omega

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_InfiniteUnidirectionalIlluminationSource

class create_InfiniteUnidirectionalIlluminationSource(
    directionDefinition=0,
    secondarySourceZenithAngle=75.0,
    secondarySourceAzimuthAngle=45.0
)

Angle definition Angle definition Zenith angle Zenith angle Azimuth angle Azimuth angle

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

directionDefinition

member_data_items_

secondarySourceAzimuthAngle

secondarySourceZenithAngle

subclass

superclass

tzoff_pattern

Class methods

Instance variables

directionDefinition

secondarySourceAzimuthAngle

secondarySourceZenithAngle

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_LatLon

class create_LatLon(
    latitude=0,
    longitude=0,
    altitude=35600.0
)

Latitude Latitude Longitude Longitude Altitude Altitude

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

altitude

latitude

longitude

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

altitude

latitude

longitude

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_OversampledPlane

class create_OversampledPlane(
    oversampledAxis=0,
    phi=65.0,
    deltaTheta=10.0,
    omega=0.001,
    defRange=0,
    imageDirection=0,
    thetaRange=None
)

Selecting Azimuth defines a vertical plane, Zenith an horizontal plane. Selecting Azimuth defines a vertical plane, Zenith an horizontal plane. Plane fixed angle Plane fixed angle Step between each direction in the oversampled plane in the [0°, 90°] range. Step between each direction in the oversampled plane in the [0°, 90°] range. Solid angle for each direction in the oversampled plane (in steradians). Solid angle for each direction in the oversampled plane (in steradians). Define an angular range. Otherwise, the full plane (360°) is oversampled for a fixed zenith and the upward hemisphere for a fixed azimuth. Define an angular range. Otherwise, the full plane (360°) is oversampled for a fixed zenith and the upward hemisphere for a fixed azimuth. If checked, images will be systematically generated for all the directions in this oversampling plane, unless images production has been totally disable in the product tab. If checked, images will be systematically generated for all the directions in this oversampling plane, unless images production has been totally disable in the product tab.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

defRange

deltaTheta

imageDirection

member_data_items_

omega

oversampledAxis

phi

subclass

superclass

thetaRange

tzoff_pattern

Class methods

Instance variables

defRange

deltaTheta

imageDirection

omega

oversampledAxis

phi

thetaRange

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_Penumbra

class create_Penumbra(
    mode=0,
    SunSphere=None,
    SunIcoSphere=None
)

All cells are empty at a distance less than "a x local tree crown radius" All cells are empty at a distance less than "a x local tree crown radius" The sun penumbra is the region in which only a portion of the sun is obscured by the occluding body. The sun penumbra is the region in which only a portion of the sun is obscured by the occluding body.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

SunIcoSphere

SunSphere

Tag_strip_pattern_

member_data_items_

mode

subclass

superclass

tzoff_pattern

Class methods

Instance variables

SunIcoSphere

SunSphere

mode

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_Rectangle

class create_Rectangle(
    deltaTheta=2,
    deltaPhi=2
)

Zenithal width of the region in the [0°, 180°] range Zenithal width of the region in the [0°, 180°] range Azimuthal width of the region in the [0°, 360°] range Azimuthal width of the region in the [0°, 360°] range

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

deltaPhi

deltaTheta

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

deltaPhi

deltaTheta

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_Region

class create_Region(
    regionType=0,
    ifSquareShape=1,
    ifPhaseOnly=0,
    ifVirtual=0,
    numberOfDirections=25,
    imageDirection=1,
    ZenithAzimuth=None,
    LatLon=None,
    Rectangle=None,
    Square=None
)

To enter directly the central angles of the region, choose "Zenith+Azimuth". Dart is also able to automaticaly determinate the central angles of a region given the LatLon coordinates of the (theorical) sensor and the scene, while taking in account the curves of the Earth. To do this, choose "LatLon Coordinates". To enter directly the central angles of the region, choose "Zenith+Azimuth". Dart is also able to automaticaly determinate the central angles of a region given the LatLon coordinates of the (theorical) sensor and the scene, while taking in account the curves of the Earth. To do this, choose "LatLon Coordinates". The shape used to described the region The shape used to described the region The oversampling directions are used only in the calculation of phase functions, which in DART module, are used to increase the directional sampling for selection of instant directional phase function during scattering event. The directions are essentially virtual. The oversampling directions are used only in the calculation of phase functions, which in DART module, are used to increase the directional sampling for selection of instant directional phase function during scattering event. The directions are essentially virtual. All the oversampled direction have virtual property All the oversampled direction have virtual property Number of directions in region. Automatically rounded to the nearest squared integer. Number of directions in region. Automatically rounded to the nearest squared integer. If checked, images will be systematically generated for all the directions in this region, unless images production has been totally disable in the product tab. If checked, images will be systematically generated for all the directions in this region, unless images production has been totally disable in the product tab.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

LatLon

Rectangle

Square

Tag_strip_pattern_

ZenithAzimuth

ifPhaseOnly

ifSquareShape

ifVirtual

imageDirection

member_data_items_

numberOfDirections

regionType

subclass

superclass

tzoff_pattern

Class methods

Instance variables

LatLon

Rectangle

Square

ZenithAzimuth

ifPhaseOnly

ifSquareShape

ifVirtual

imageDirection

numberOfDirections

regionType

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_SecondaryIlluminationSource

class create_SecondaryIlluminationSource(
    type_=0,
    irradianceMode=0,
    InfiniteUnidirectionalIlluminationSource=None,
    SphereIlluminationSource=None,
    irradianceDatabaseNode=None,
    BandIrradianceFileNode=None,
    SpectralIrradiances=None
)

Type Type Irradiance definition Irradiance definition

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

BandIrradianceFileNode

InfiniteUnidirectionalIlluminationSource

SpectralIrradiances

SphereIlluminationSource

Tag_strip_pattern_

irradianceDatabaseNode

irradianceMode

member_data_items_

subclass

superclass

type_

tzoff_pattern

Class methods

Instance variables

BandIrradianceFileNode

InfiniteUnidirectionalIlluminationSource

SpectralIrradiances

SphereIlluminationSource

irradianceDatabaseNode

irradianceMode

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_SpectralIrradianceValue

class create_SpectralIrradianceValue(
    irradiance=1000,
    Skyl=0
)

Value Value SKYL [0,1] SKYL [0,1]

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Skyl

Tag_strip_pattern_

irradiance

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

Skyl

irradiance

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_SpectralIrradiances

class create_SpectralIrradiances(
    commonSkylCheckBox=1,
    commonIrradianceCheckBox=1,
    irraDef=0,
    SpectralIrradianceValue=None
)

Same solar SKYL for all bands Same solar SKYL for all bands Same solar radiation for all bands Same solar radiation for all bands Incoming radiation definition Incoming radiation definition

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

SpectralIrradianceValue

Tag_strip_pattern_

commonIrradianceCheckBox

commonSkylCheckBox

irraDef

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

SpectralIrradianceValue

commonIrradianceCheckBox

commonSkylCheckBox

irraDef

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_SphereDirection

class create_SphereDirection(
    directionDefinition=0,
    secondarySourceZenithAngle=75.0,
    secondarySourceAzimuthAngle=45.0,
    distance=384399000
)

Angle definition Angle definition Central Zenith Angle Central Zenith Angle Central Azimuth Angle Central Azimuth Angle Distance to sphere center Distance to sphere center

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

directionDefinition

distance

member_data_items_

secondarySourceAzimuthAngle

secondarySourceZenithAngle

subclass

superclass

tzoff_pattern

Class methods

Instance variables

directionDefinition

distance

secondarySourceAzimuthAngle

secondarySourceZenithAngle

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_SphereIlluminationSource

class create_SphereIlluminationSource(
    sphereRadius=1737400,
    sampling=25,
    positionDefinition=0,
    SphereDirection=None,
    SphereIlluminationSourcePosition=None
)

Sphere radius Sphere radius In DART-FT (Flux-Tracking), defines how many rays will be emitted from the sphere toward the scene per illumination center. The larger the solid angle of the sphere relative to the scene, the higher this number should be. In DART-FT (Flux-Tracking), defines how many rays will be emitted from the sphere toward the scene per illumination center. The larger the solid angle of the sphere relative to the scene, the higher this number should be. Sphere position definition Sphere position definition

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

SphereDirection

SphereIlluminationSourcePosition

Tag_strip_pattern_

member_data_items_

positionDefinition

sampling

sphereRadius

subclass

superclass

tzoff_pattern

Class methods

Instance variables

SphereDirection

SphereIlluminationSourcePosition

positionDefinition

sampling

sphereRadius

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_SphereIlluminationSourcePosition

class create_SphereIlluminationSourcePosition(
    secondarySourcePositionX=262549399.0,
    secondarySourcePositionY=262549399.0,
    secondarySourcePositionZ=271811139.0
)

X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

secondarySourcePositionX

secondarySourcePositionY

secondarySourcePositionZ

subclass

superclass

tzoff_pattern

Class methods

Instance variables

secondarySourcePositionX

secondarySourcePositionY

secondarySourcePositionZ

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_Square

class create_Square(
    widthDefinition=0,
    DefineOmega=None,
    DefineDeltaPhi=None,
    DefineDeltaTheta=None
)

The parameter used to described the width of the square. The parameter used to described the width of the square.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

DefineDeltaPhi

DefineDeltaTheta

DefineOmega

Tag_strip_pattern_

member_data_items_

subclass

superclass

tzoff_pattern

widthDefinition

Class methods

Instance variables

DefineDeltaPhi

DefineDeltaTheta

DefineOmega

widthDefinition

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_Sun

class create_Sun(
    sunZenithAngle=150.0,
    sunAzimuthAngle=45.0,
    dayOfTheYear=-1
)

Zenith angle of the sun direction in the ]90°, 180°] range (Sun to Ground) Zenith angle of the sun direction in the ]90°, 180°] range (Sun to Ground) Azimuth angle of the sun downward direction in [0°, 360°], anticlockwise from the reference direction. The Ox direction (vertical on the 2D display of the scene) is the reference direction in the xy plane. Azimuth angle of the sun downward direction in [0°, 360°], anticlockwise from the reference direction. The Ox direction (vertical on the 2D display of the scene) is the reference direction in the xy plane. Day of the year (from 1 to 365). Set it to -1 to ignore. Used to compute the Sun-Earth distance and the subsequent correction to apply to the solar illumination. Day of the year (from 1 to 365). Set it to -1 to ignore. Used to compute the Sun-Earth distance and the subsequent correction to apply to the solar illumination.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

dayOfTheYear

member_data_items_

subclass

sunAzimuthAngle

sunZenithAngle

superclass

tzoff_pattern

Class methods

Instance variables

dayOfTheYear

sunAzimuthAngle

sunZenithAngle

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_SunIcoSphere

class create_SunIcoSphere(
    nbSudivisions=0
)

Total number of points will be: ~10 * 4 ^ (nb_subdivisions) The sun is defined as an Icosahedron: a regular polyhedron with 20 equilateral triangles of same area. Each subdivision multiply by 4 the number of triangles. Half the faces are going to illuminate the scene. Total number of points will be: ~10 * 4 ^ (nb_subdivisions) The sun is defined as an Icosahedron: a regular polyhedron with 20 equilateral triangles of same area. Each subdivision multiply by 4 the number of triangles. Half the faces are going to illuminate the scene.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

nbSudivisions

subclass

superclass

tzoff_pattern

Class methods

Instance variables

nbSudivisions

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_SunSphere

class create_SunSphere(
    nbPointsOnSphere=4
)

Defines the numbers of points to be randomly sampled on the sun surface IN ADDITION of the central position. Multiply linearly the computation time of the direct illumination phase. Defines the numbers of points to be randomly sampled on the sun surface IN ADDITION of the central position. Multiply linearly the computation time of the direct illumination phase.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

nbPointsOnSphere

subclass

superclass

tzoff_pattern

Class methods

Instance variables

nbPointsOnSphere

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_SunViewingAngles

class create_SunViewingAngles(
    sunViewingZenithAngle=30.0,
    sunViewingAzimuthAngle=225.0,
    dayOfTheYear=-1
)

Zenith angle of the sun direction in the [0°, 90°[ range (Ground to Sun) Zenith angle of the sun direction in the [0°, 90°[ range (Ground to Sun) Azimuth angle of the sun downward direction in [0°, 360°], anticlockwise from the reference direction. The Ox direction (vertical on the 2D display of the scene) is the reference direction in the xy plane. Azimuth angle of the sun downward direction in [0°, 360°], anticlockwise from the reference direction. The Ox direction (vertical on the 2D display of the scene) is the reference direction in the xy plane. Day of the year (from 1 to 365). Set it to -1 to ignore. Used to compute the Sun-Earth distance and the subsequent correction to apply to the solar illumination. Day of the year (from 1 to 365). Set it to -1 to ignore. Used to compute the Sun-Earth distance and the subsequent correction to apply to the solar illumination.

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

dayOfTheYear

member_data_items_

subclass

sunViewingAzimuthAngle

sunViewingZenithAngle

superclass

tzoff_pattern

Class methods

Instance variables

dayOfTheYear

sunViewingAzimuthAngle

sunViewingZenithAngle

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_ZenithAzimuth

class create_ZenithAzimuth(
    directionZenithalAngle=40.0,
    directionAzimuthalAngle=0
)

Zenith angle of the added direction: - value in [0°, 90°[ adds an upward region. - value in ]90°, 180°] adds a downward region. Zenith angle of the added direction: - value in [0°, 90°[ adds an upward region. - value in ]90°, 180°] adds a downward region. Azimuth angle of the added direction (between O° and 360°) Azimuth angle of the added direction (between O° and 360°)

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

directionAzimuthalAngle

directionZenithalAngle

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

directionAzimuthalAngle

directionZenithalAngle

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_irradianceDatabaseNode

class create_irradianceDatabaseNode(
    databaseName='Solar_constant.db',
    irradianceTable='TOASolar_THKUR',
    irradianceColumn='irradiance'
)

Irradiance database Irradiance database Database name Database name Irradiance table Irradiance table Irradiance model Irradiance model

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

databaseName

irradianceColumn

irradianceTable

member_data_items_

subclass

superclass

tzoff_pattern

Class methods

Instance variables

databaseName

irradianceColumn

irradianceTable

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_thetaRange

class create_thetaRange(
    theta__0=-80,
    theta__1=80
)

Begin [°] Begin [°] End [°] End [°]

Ancestors (in MRO)

  • pytools4dart.core_ui.directions.GeneratedsSuper

Class variables

Tag_strip_pattern_

member_data_items_

subclass

superclass

theta__0

theta__1

tzoff_pattern

Class methods

Instance variables

theta__0

theta__1

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