Skip to content

Module pytools4dart.core_ui.phase

Classes

createDartFile

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

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Phase
Tag_strip_pattern_
build_
member_data_items_
subclass
superclass
tzoff_pattern
version

Class methods

Instance variables

Phase
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_ALS

class create_ALS(
    sensorHeight=10,
    Swath=None
)

ALS ALS Altitude of LIDAR platform Altitude of LIDAR platform

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Swath
Tag_strip_pattern_
member_data_items_
sensorHeight
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Swath
sensorHeight

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_AirConfig

class create_AirConfig(
    airSNConfig=0
)

Airborne configuration Airborne configuration Airborne Airborne

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
airSNConfig
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

airSNConfig

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_ApproximatedTrajectory

class create_ApproximatedTrajectory(
    platformDirection=0,
    platformAzimuth=0,
    SensorPos=None
)

Approximated Trajectory Approximated Trajectory The azimuth angle that represent the platform moving direction The azimuth angle that represent the platform moving direction Acquisition azimuth angle relative to the plane perpendicular to the flight direction Acquisition azimuth angle relative to the plane perpendicular to the flight direction

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SensorPos
Tag_strip_pattern_
member_data_items_
platformAzimuth
platformDirection
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SensorPos
platformAzimuth
platformDirection

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_Atmosphere

class create_Atmosphere(
    atmosphereGeometry=0,
    AtmosphereHorizontal=None,
    AtmosphereSphere=None,
    AtmosphereEllipsoid=None,
    AtmosphereBackgroundProperties=None
)

Atmosphere geometry and properties Atmosphere geometry and properties Geometry Geometry

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

AtmosphereBackgroundProperties
AtmosphereEllipsoid
AtmosphereHorizontal
AtmosphereSphere
Tag_strip_pattern_
atmosphereGeometry
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AtmosphereBackgroundProperties
AtmosphereEllipsoid
AtmosphereHorizontal
AtmosphereSphere
atmosphereGeometry

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_AtmosphereBackgroundProperties

class create_AtmosphereBackgroundProperties(
    OpticalPropertyLink=None,
    ThermalPropertyLink=None
)

Background optical and temperature properties Background optical and temperature properties

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

OpticalPropertyLink
Tag_strip_pattern_
ThermalPropertyLink
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

OpticalPropertyLink
ThermalPropertyLink

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_AtmosphereEllipsoid

class create_AtmosphereEllipsoid(
    AtmosphereEllipsoidAxes=None,
    AtmosphereEllipsoidRotation=None
)

Ellipsoid definition Ellipsoid definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

AtmosphereEllipsoidAxes
AtmosphereEllipsoidRotation
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AtmosphereEllipsoidAxes
AtmosphereEllipsoidRotation

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_AtmosphereEllipsoidAxes

class create_AtmosphereEllipsoidAxes(
    directionX=6371,
    directionY=6371,
    directionZ=6371
)

Semi axes Semi axes Direction X Direction X Direction Y Direction Y Direction Z Direction Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
directionX
directionY
directionZ
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

directionX
directionY
directionZ

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_AtmosphereEllipsoidRotation

class create_AtmosphereEllipsoidRotation(
    rotationZ1=0,
    rotationY=0,
    rotationZ2=0
)

Rotation (Euler angles ZYZ) Rotation (Euler angles ZYZ) Intrinsic rotation Intrinsic rotation Nutation (inclination) Nutation (inclination) Precession Precession

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
rotationY
rotationZ1
rotationZ2
subclass
superclass
tzoff_pattern

Class methods

Instance variables

rotationY
rotationZ1
rotationZ2

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_AtmosphereHorizontal

class create_AtmosphereHorizontal(
    atmosphereFinite=1,
    Finite=None
)

Atmosphere horizontal dimension Atmosphere horizontal dimension Finite Finite

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Finite
Tag_strip_pattern_
atmosphereFinite
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Finite
atmosphereFinite

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_AtmosphereRadiativeTransfer

class create_AtmosphereRadiativeTransfer(
    TOAtoBOA=0,
    AtmosphereRadiativeTransferOptions=None
)

Passage from TOA to BOA. - No Atmosphere RT: No simulation of the atmosphere radiative transfer. Irradiance Passage from TOA to BOA. - No Atmosphere RT: No simulation of the atmosphere radiative transfer. Irradiance

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

AtmosphereRadiativeTransferOptions
TOAtoBOA
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AtmosphereRadiativeTransferOptions
TOAtoBOA

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_AtmosphereRadiativeTransferOptions

class create_AtmosphereRadiativeTransferOptions(
    couplingEnabled=1
)

Disable COUPL and TOA level product. The Earth-Atmosphere coupling simulates the exchange process of energy between the Earth scene and the atmosphere: part of the energy scattered by the Earth- scene is intercepted again by the atmosphere and back-scattered toward the Earth, and this potentially multiple times. This process can be sometimes fairly time-consuming for a small contribution to the radiative budget, depending on the spectral band and the scene constitution. Disable COUPL and TOA level product. The Earth-Atmosphere coupling simulates the exchange process of energy between the Earth scene and the atmosphere: part of the energy scattered by the Earth-scene is intercepted again by the atmosphere and back-scattered toward the Earth, and this potentially multiple times. This process can be sometimes fairly time-consuming for a small contribution to the radiative budget, depending on the spectral band and the scene constitution.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
couplingEnabled
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

couplingEnabled

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_AtmosphereSphere

class create_AtmosphereSphere(
    atmosphereRadius=6371
)

Sphere definition Sphere definition Radius Radius

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
atmosphereRadius
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atmosphereRadius

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_BRFBiDirParameters

class create_BRFBiDirParameters(
    brfMap=1,
    brfResolution=1,
    targetRayDensityPerDirection=50
)

Bi-directional BRF/BTF parameter Bi-directional BRF/BTF parameter Generates a 90 x 360 images of the scene radiance/reflectance per couple of (Zenith; Azimuth) angles. Generates a 90 x 360 images of the scene radiance/reflectance per couple of (Zenith; Azimuth) angles. BRFMap resolution (Bi-directional mode) BRFMap resolution (Bi-directional mode) Set to 0 to disable. The process will then stop if it reaches the time limit or if killed by the user. Set to 0 to disable. The process will then stop if it reaches the time limit or if killed by the user.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
brfMap
brfResolution
member_data_items_
subclass
superclass
targetRayDensityPerDirection
tzoff_pattern

Class methods

Instance variables

brfMap
brfResolution
targetRayDensityPerDirection

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_BRFCamera

class create_BRFCamera(
    sensorDisabled=0,
    defineCustomPlane=0,
    camera_Definition=0,
    camera_nbOfSamplesPerPixel=50,
    BRFCamera_subregion=None,
    BRFCamera_oversampled=None,
    CustomPlane=None
)

BRF camera BRF camera Disable Sensor Disable Sensor Define custom plane Define custom plane Camera definiton Camera definiton Number of samples per pixel Number of samples per pixel

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFCamera_oversampled
BRFCamera_subregion
CustomPlane
Tag_strip_pattern_
camera_Definition
camera_nbOfSamplesPerPixel
defineCustomPlane
member_data_items_
sensorDisabled
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BRFCamera_oversampled
BRFCamera_subregion
CustomPlane
camera_Definition
camera_nbOfSamplesPerPixel
defineCustomPlane
sensorDisabled

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_BRFCamera_oversampled

class create_BRFCamera_oversampled(
    camera_fixedAngleType=0,
    BRFCamera_oversampled_thetaFixed=None,
    BRFCamera_oversampled_phiFixed=None
)

Oversampled plane Oversampled plane Fixed angle Fixed angle

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFCamera_oversampled_phiFixed
BRFCamera_oversampled_thetaFixed
Tag_strip_pattern_
camera_fixedAngleType
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BRFCamera_oversampled_phiFixed
BRFCamera_oversampled_thetaFixed
camera_fixedAngleType

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_BRFCamera_oversampled_phiFixed

class create_BRFCamera_oversampled_phiFixed(
    camera_theta1=-90,
    camera_theta2=90,
    camera_stepTheta='1',
    camera_fixedPhi=0
)

Fixed phi Fixed phi Theta 1 Theta 1 Theta 2 Theta 2 Step theta Step theta Fixed phi Fixed phi

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
camera_fixedPhi
camera_stepTheta
camera_theta1
camera_theta2
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

camera_fixedPhi
camera_stepTheta
camera_theta1
camera_theta2

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_BRFCamera_oversampled_thetaFixed

class create_BRFCamera_oversampled_thetaFixed(
    camera_phi1=0,
    camera_phi2=180,
    camera_stepPhi='1',
    camera_fixedTheta=0
)

Fixed theta Fixed theta Phi 1 Phi 1 Phi 2 Phi 2 Step phi Step phi Fixed theta Fixed theta

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
camera_fixedTheta
camera_phi1
camera_phi2
camera_stepPhi
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

camera_fixedTheta
camera_phi1
camera_phi2
camera_stepPhi

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_BRFCamera_subregion

class create_BRFCamera_subregion(
    BRFCamera_subregion_position=None,
    BRFCamera_subregion_resolution=None
)

Sub region Sub region

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFCamera_subregion_position
BRFCamera_subregion_resolution
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BRFCamera_subregion_position
BRFCamera_subregion_resolution

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_BRFCamera_subregion_position

class create_BRFCamera_subregion_position(
    camera_theta1=-90,
    camera_phi1=0,
    camera_theta2=90,
    camera_phi2=180
)

Camera position Camera position Theta 1 Theta 1 Phi 1 Phi 1 Theta 2 Theta 2 Phi 2 Phi 2

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
camera_phi1
camera_phi2
camera_theta1
camera_theta2
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

camera_phi1
camera_phi2
camera_theta1
camera_theta2

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_BRFCamera_subregion_resolution

class create_BRFCamera_subregion_resolution(
    camera_resolution=1
)

Resolution Resolution Resolution Resolution

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
camera_resolution
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

camera_resolution

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_BRFParameters

class create_BRFParameters(
    brfFileType=0,
    BRFTextParameters=None,
    BRFBiDirParameters=None
)

Write BRF/BTF parameters Write BRF/BTF parameters UNDEFINED UNDEFINED

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFBiDirParameters
BRFTextParameters
Tag_strip_pattern_
brfFileType
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BRFBiDirParameters
BRFTextParameters
brfFileType

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_BRFProductForwardProperties

class create_BRFProductForwardProperties(
    extrapolation=1,
    horizontalOversampling=1,
    sensorOversampling=1,
    nb_scene=1
)

Forward BRF/BTF Products Forward BRF/BTF Products Extrapolation of radiation products Extrapolation of radiation products horizontalOversampling horizontalOversampling sensorOversampling sensorOversampling Number of repeated scenes for image creation Number of repeated scenes for image creation

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
extrapolation
horizontalOversampling
member_data_items_
nb_scene
sensorOversampling
subclass
superclass
tzoff_pattern

Class methods

Instance variables

extrapolation
horizontalOversampling
nb_scene
sensorOversampling

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_BRFTextParameters

class create_BRFTextParameters(
    brfProduct=1,
    centralizedBrfProduct=1
)

UNDEFINED UNDEFINED UNDEFINED UNDEFINED UNDEFINED UNDEFINED

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
brfProduct
centralizedBrfProduct
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

brfProduct
centralizedBrfProduct

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_BackSide

class create_BackSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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'
)

Text file containing lines of |wavelength sunRadiationValue SKYL|. The data is expected to be sorted by ascending wavelength. SKYL is ignored and radiation are treated as being TOA in Analytical or Radiative Transfer Atmospheres. Text file containing lines of |wavelength sunRadiationValue SKYL|. The data is expected to be sorted by ascending wavelength. SKYL is ignored and radiation are treated as being TOA in Analytical or Radiative Transfer Atmospheres.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.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_BottomSide

class create_BottomSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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_BrfProductsProperties

class create_BrfProductsProperties(
    image=1,
    writeBrf=1,
    maximalThetaImages=1.0,
    sensorPlaneprojection=1,
    projection=0,
    luminanceProducts=0,
    transmittanceImages=0,
    pixelToSceneCorrespondences=0,
    pixelDirectionImageGeneration=0,
    generatePerTypeProduct=0,
    ExpertModeZone_Etalement=None,
    BRFParameters=None,
    ExpertModeZone_maskProjection=None,
    BRFProductForwardProperties=None
)

BrfProductsProperties BrfProductsProperties Images are coded in double Images are coded in double Write BRF/BTF Write BRF/BTF This is a threshold on the zenith angle of view directions: only images with a zenith angle smaller than this threshold are stored (in order to save computer memory) This is a threshold on the zenith angle of view directions: only images with a zenith angle smaller than this threshold are stored (in order to save computer memory) Orthoprojection (better use without sensor plane image nor oversampling) Orthoprojection (better use without sensor plane image nor oversampling) Orthoprojection (better use without sensor plane image nor oversampling) Orthoprojection (better use without sensor plane image nor oversampling) Radiance are in [W/m²/sr/μm]. Reflectance is radiance divided by illumination and PI. In T and R+T mode, products are in Brightness Temperature instead of reflectance. Radiance are in [W/m²/sr/μm]. Reflectance is radiance divided by illumination and PI. In T and R+T mode, products are in Brightness Temperature instead of reflectance. Fluid Transmittance images Fluid Transmittance images The correspondences are computed for the center of the pixels and are stored in the format [u,v,x,y,z] where u and v are the pixel indices and x,y and z are the corresponding coordinates in the scene. The correspondences are computed for the center of the pixels and are stored in the format [u,v,x,y,z] where u and v are the pixel indices and x,y and z are the corresponding coordinates in the scene. For each defined sensor/direction, provides an additional image at the same resolution where each pixel stores its corresponding viewing angles (zenith, azimuth). For each defined sensor/direction, provides an additional image at the same resolution where each pixel stores its corresponding viewing angles (zenith, azimuth). Generates seperated images for each type/color defined in the scene (such as roads, walls, vegetation or any custom type defined for 3D imported objects). Currently only available for the option "Precise (slow)" Spreading of rays Generates seperated images for each type/color defined in the scene (such as roads, walls, vegetation or any custom type defined for 3D imported objects). Currently only available for the option "Precise (slow)" Spreading of rays

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFParameters
BRFProductForwardProperties
ExpertModeZone_Etalement
ExpertModeZone_maskProjection
Tag_strip_pattern_
generatePerTypeProduct
image
luminanceProducts
maximalThetaImages
member_data_items_
pixelDirectionImageGeneration
pixelToSceneCorrespondences
projection
sensorPlaneprojection
subclass
superclass
transmittanceImages
tzoff_pattern
writeBrf

Class methods

Instance variables

BRFParameters
BRFProductForwardProperties
ExpertModeZone_Etalement
ExpertModeZone_maskProjection
generatePerTypeProduct
image
luminanceProducts
maximalThetaImages
pixelDirectionImageGeneration
pixelToSceneCorrespondences
projection
sensorPlaneprojection
transmittanceImages
writeBrf

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_CameraAltitude

class create_CameraAltitude(
    altitudeDefinition=0,
    cameraDistance=100
)

Camera distance to target Camera distance to target Distance definition Distance definition Camera position Camera position

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
altitudeDefinition
cameraDistance
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

altitudeDefinition
cameraDistance

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_CameraOrientYPR

class create_CameraOrientYPR(
    rotDefBT=5,
    yaw=0,
    pitch=-90,
    roll=180
)

Camera orientation (Tait-Bryan Angles) Camera orientation (Tait- Bryan Angles) Rotation Order (123) Rotation Order (123) Z Z Y Y X X

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
pitch
roll
rotDefBT
subclass
superclass
tzoff_pattern
yaw

Class methods

Instance variables

pitch
roll
rotDefBT
yaw

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_CameraTarget

class create_CameraTarget(
    targetX=20.0,
    targetY=20.0,
    targetZ=0.0
)

Target Position Target Position X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
targetX
targetY
targetZ
tzoff_pattern

Class methods

Instance variables

targetX
targetY
targetZ

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_CellComponents

class create_CellComponents(
    intercepted=1,
    scattered=1,
    emitted=1,
    absorbed=1,
    bottomExit=0,
    bottomEntry=0,
    topExit=1,
    topEntry=1,
    frontExit=0,
    frontEntry=0,
    rightExit=0,
    rightEntry=0,
    backExit=0,
    backEntry=0,
    leftExit=0,
    leftEntry=0,
    totalExit=0,
    totalEntry=0
)

Energy intercepted by elements within the cell Energy intercepted by elements within the cell Energy scattered by elements within the cell Energy scattered by elements within the cell Energy emitted by elements within the cell Energy emitted by elements within the cell Energy absorbed by elements within the cell Energy absorbed by elements within the cell Energy exiting the cell through the bottom face (-Z) Energy exiting the cell through the bottom face (-Z) Energy entering the cell through the bottom face (-Z) Energy entering the cell through the bottom face (-Z) Energy exiting the cell through the top face (+Z) Energy exiting the cell through the top face (+Z) Energy entering the cell through the top face (+Z) Energy entering the cell through the top face (+Z) Energy exiting the cell through the front face (+X) Energy exiting the cell through the front face (+X) Energy entering the cell through the front face (+X) Energy entering the cell through the front face (+X) Energy exiting the cell through the right face (+Y) Energy exiting the cell through the right face (+Y) Energy entering the cell through the right face (+Y) Energy entering the cell through the right face (+Y) Energy exiting the cell through the back face (-X) Energy exiting the cell through the back face (-X) Energy entering the cell through the back face (-X) Energy entering the cell through the back face (-X) Energy exiting the cell through the left face (-Y) Energy exiting the cell through the left face (-Y) Energy entering the cell through the left face (-Y) Energy entering the cell through the left face (-Y) Total energy exiting the cell Total energy exiting the cell Total energy entering the cell Total energy entering the cell

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
absorbed
backEntry
backExit
bottomEntry
bottomExit
emitted
frontEntry
frontExit
intercepted
leftEntry
leftExit
member_data_items_
rightEntry
rightExit
scattered
subclass
superclass
topEntry
topExit
totalEntry
totalExit
tzoff_pattern

Class methods

Instance variables

absorbed
backEntry
backExit
bottomEntry
bottomExit
emitted
frontEntry
frontExit
intercepted
leftEntry
leftExit
rightEntry
rightExit
scattered
topEntry
topExit
totalEntry
totalExit

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_CenterBegin

class create_CenterBegin(
    x=5,
    y=20
)

CenterBegin CenterBegin X coordinate of the starting position of the LIDAR swath region X coordinate of the starting position of the LIDAR swath region Y coordinate of the starting position of the LIDAR swath region Y coordinate of the starting position of the LIDAR swath region

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.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_CenterEnd

class create_CenterEnd(
    x=35,
    y=20
)

CenterEnd CenterEnd X coordinate of the finishing position of the LIDAR swath region X coordinate of the finishing position of the LIDAR swath region Y coordinate of the finishing position of the LIDAR swath region Y coordinate of the finishing position of the LIDAR swath region

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.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_CenterOnGround

class create_CenterOnGround(
    decalageLidar_x=20,
    decalageLidar_y=20
)

CenterOnGround CenterOnGround x coordinate of illumination of the LIDAR on the ground. (0, 0) is the top left corner x coordinate of illumination of the LIDAR on the ground. (0, 0) is the top left corner y coordinate of illumination of the LIDAR on the ground. (0, 0) is the top left corner y coordinate of illumination of the LIDAR on the ground. (0, 0) is the top left corner

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
decalageLidar_x
decalageLidar_y
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

decalageLidar_x
decalageLidar_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_CommonParameters

class create_CommonParameters(
    commonSkylCheckBox=1,
    commonIrradianceCheckBox=1,
    irraDef=0
)

CommonParameters CommonParameters Same SKYL for all bands Same SKYL for all bands Same irradiance for all bands Same irradiance for all bands Incoming radiation definition Incoming radiation definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
commonIrradianceCheckBox
commonSkylCheckBox
irraDef
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

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_CommonProducts

class create_CommonProducts(
    radiativeBudgetProducts=0,
    polarizationProducts=0,
    perLightSource=0,
    JacobianProducts=0,
    radiativeBudgetProperties=None
)

3D and 1D distribution of radiation that is incident, intercepted, absorbed and scattered, for each non empty cell. 3D and 1D distribution of radiation that is incident, intercepted, absorbed and scattered, for each non empty cell. Specifies if the polarization is taken into account in the radiative transfer or not. The state of polarization of a wave is described by the 4 components of the Stokes Vector. Not polarized for the sun illumination, the light can be polarized by a physical phenomenon (specular reflection, rayleigh scattering). Specifies if the polarization is taken into account in the radiative transfer or not. The state of polarization of a wave is described by the 4 components of the Stokes Vector. Not polarized for the sun illumination, the light can be polarized by a physical phenomenon (specular reflection, rayleigh scattering). Per light source products Per light source products UNDEFINED UNDEFINED

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

JacobianProducts
Tag_strip_pattern_
member_data_items_
perLightSource
polarizationProducts
radiativeBudgetProducts
radiativeBudgetProperties
subclass
superclass
tzoff_pattern

Class methods

Instance variables

JacobianProducts
perLightSource
polarizationProducts
radiativeBudgetProducts
radiativeBudgetProperties

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_Components

class create_Components(
    CellComponents=None,
    ElementComponents=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CellComponents
ElementComponents
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CellComponents
ElementComponents

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_ControlPoint

class create_ControlPoint(
    definition=1,
    PositionGround=None,
    CorrespondingParameters=None
)

ControlPoint ControlPoint Mode of definition of the control point. Mode of definition of the control point.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CorrespondingParameters
PositionGround
Tag_strip_pattern_
definition
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CorrespondingParameters
PositionGround
definition

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_CorrespondingParameters

class create_CorrespondingParameters(
    lookAngle=0
)

CorrespondingParameters CorrespondingParameters Look angle of the platform for the given control point Look angle of the platform for the given control point

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
lookAngle
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

lookAngle

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_CustomPlane

class create_CustomPlane(
    customPlaneX=0,
    customPlaneY=0,
    customPlaneHeight=10,
    customPlaneDX=1,
    customPlaneDY=1,
    domeType=0,
    customPlaneDirectionX=0,
    customPlaneDirectionY=0,
    customPlaneDirectionZ=0,
    HemisphericalDome=None,
    HorizontalDome=None
)

Custom plane Custom plane X X Y Y Height Height Dimension X Dimension X Dimension Y Dimension Y Dome type Dome type Normal of the target (plane) Normal of the target (plane) Normal of the target (plane) Normal of the target (plane) Normal of the target (plane) Normal of the target (plane)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

HemisphericalDome
HorizontalDome
Tag_strip_pattern_
customPlaneDX
customPlaneDY
customPlaneDirectionX
customPlaneDirectionY
customPlaneDirectionZ
customPlaneHeight
customPlaneX
customPlaneY
domeType
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

HemisphericalDome
HorizontalDome
customPlaneDX
customPlaneDY
customPlaneDirectionX
customPlaneDirectionY
customPlaneDirectionZ
customPlaneHeight
customPlaneX
customPlaneY
domeType

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_DartInputParameters

class create_DartInputParameters(
    MonteCarlo=None,
    Lidar=None,
    SpectralDomainTir=None,
    SpectralIntervals=None,
    temperatureAtmosphere=None,
    ImageSideIllumination=None,
    nodeIlluminationMode=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImageSideIllumination
Lidar
MonteCarlo
SpectralDomainTir
SpectralIntervals
Tag_strip_pattern_
member_data_items_
nodeIlluminationMode
subclass
superclass
temperatureAtmosphere
tzoff_pattern

Class methods

Instance variables

ImageSideIllumination
Lidar
MonteCarlo
SpectralDomainTir
SpectralIntervals
nodeIlluminationMode
temperatureAtmosphere

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_DartProduct

class create_DartProduct(
    dartModuleProducts=None,
    maketModuleProducts=None
)

DartProduct DartProduct

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
dartModuleProducts
maketModuleProducts
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

dartModuleProducts
maketModuleProducts

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_DiscreteReturnParam

class create_DiscreteReturnParam(
    thresAppRef=0.01,
    nbPoints=1,
    intensityValueType=2
)

Discrete-return parameters Discrete-return parameters Minimum Target Reflectance for Detection. It is sometimes specified in the white paper of the LiDAR device. It may vary with distance. Minimum Target Reflectance for Detection. It is sometimes specified in the white paper of the LiDAR device. It may vary with distance. Number of points per pulse Number of points per pulse The type of the intensity in the discrete point cloud. None: no output. The type of the intensity in the discrete point cloud. None: no output.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
intensityValueType
member_data_items_
nbPoints
subclass
superclass
thresAppRef
tzoff_pattern

Class methods

Instance variables

intensityValueType
nbPoints
thresAppRef

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_ElementComponents

class create_ElementComponents(
    intercepted=1,
    scattered=1,
    emitted=1,
    absorbed=1
)

Intercepted Energy Intercepted Energy Scattered Energy Scattered Energy Emitted Energy Emitted Energy Absorbed Energy Absorbed Energy

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
absorbed
emitted
intercepted
member_data_items_
scattered
subclass
superclass
tzoff_pattern

Class methods

Instance variables

absorbed
emitted
intercepted
scattered

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_EmbreeEngineParameters

class create_EmbreeEngineParameters(
    numberOfIteration=5,
    triangleStorageMode=0
)

DART accuracy depends on the number N_scat of scatterings that are simulated when tracing rays in the Earth scene and the atmosphere: N_scat DART accuracy depends on the number N_scat of scatterings that are simulated when tracing rays in the Earth scene and the atmosphere: N_scat The direct mode is the fastest, but also the most costly in memory. Cloning can save a lot of memory but will be much slower. The direct mode is the fastest, but also the most costly in memory. Cloning can save a lot of memory but will be much slower.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
numberOfIteration
subclass
superclass
triangleStorageMode
tzoff_pattern

Class methods

Instance variables

numberOfIteration
triangleStorageMode

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_EngineParameter

class create_EngineParameter(
    EmbreeEngineParameters=None,
    LuxCoreRenderEngineParameters=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

EmbreeEngineParameters
LuxCoreRenderEngineParameters
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

EmbreeEngineParameters
LuxCoreRenderEngineParameters

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_ExpertModeDartFt

class create_ExpertModeDartFt(
    lightPropagationThreshold=1e-07,
    albedoThreshold=0.001,
    distanceBetweenIlluminationSubCenters=0.1,
    maxNbSceneCrossing=1000,
    illuminationRepartitionMode=2,
    nbSubcenterVolume=2,
    subFaceBarycenterSubdivision=1,
    thermalEmissionSurfaceSubdivision=0.01,
    nbSubSubcenterTurbidEmission=40,
    isInterceptedPowerPerDirectionForSpecularCheck=0,
    subFaceBarycenterEnabled=1,
    surfaceBarycenterEnabled=1,
    sparseVoxelAcceleration=1,
    nbTrianglesWithinVoxelAcceleration=10
)

Any ray is discarded if its energy becomes less than {"Threshold" x "Mean energy /steradian" derived from iterations 1 and 2 x "Solid angle of the ray"} Any ray is discarded if its energy becomes less than {"Threshold" x "Mean energy /steradian" derived from iterations 1 and 2 x "Solid angle of the ray"} The DART run stops if the variation of scene albedo between consecutive iterations is less than the threshold The DART run stops if the variation of scene albedo between consecutive iterations is less than the threshold BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E If a ray travels through more scene than the specified value, it is stopped and its energy registered as lost. Notably useful to prevent rays parallel or quasi-parallel to the scene in infinite slope mode. If a ray travels through more scene than the specified value, it is stopped and its energy registered as lost. Notably useful to prevent rays parallel or quasi-parallel to the scene in infinite slope mode. To Write To Write Used to oversample within cell scattering and to set the number of radiation source points from each cell face in coordination with the factor M. - Each cell has N^3 sub-cells. There can be 1 scattering point per sub-cell (i.e., N³ scattering points / cell). Thus, a triangle can have m scattering points if it crosses m sub-cells. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to oversample within cell scattering and to set the number of radiation source points from each cell face in coordination with the factor M. - Each cell has N^3 sub-cells. There can be 1 scattering point per sub-cell (i.e., N³ scattering points / cell). Thus, a triangle can have m scattering points if it crosses m sub-cells. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to set the number of radiation source points from each cell face in coordination with the factor N. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to set the number of radiation source points from each cell face in coordination with the factor N. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. A ray will be emitted every S m2 during the thermal emission. A ray will be emitted every S m2 during the thermal emission. Thermal emission from a turbid cell arises from the center of each cell sub-face. It is equal to "Geometric factor G(ω)" x "Planck's radiance L(μ, cell temperature)". G(ω) is precomputed per cell sub-face as a numerical integral, using N² integration points per cell sub- face. Thermal emission from a turbid cell arises from the center of each cell sub-face. It is equal to "Geometric factor G(ω)" x "Planck's radiance L(μ, cell temperature)". G(ω) is precomputed per cell sub-face as a numerical integral, using N² integration points per cell sub-face. Specifies if the intercepted power per direction is stored for the specular reflection and refraction or not As the specular phenomenon is very directional, it is necessary to store the intercepted power per direction to well represent it. However, one can choose to well represent the first order of scattering and to assume the other as Lambertian. Specifies if the intercepted power per direction is stored for the specular reflection and refraction or not As the specular phenomenon is very directional, it is necessary to store the intercepted power per direction to well represent it. However, one can choose to well represent the first order of scattering and to assume the other as Lambertian. When multiple rays exit a cell through the same sub-face with the same direction, they are regrouped into a single ray in order to minimize tracking time. When multiple rays exit a cell through the same sub-face with the same direction, they are regrouped into a single ray in order to minimize tracking time. If multiple rays are intercepted by the same surface, they are later scattered as a single point (or more, depending of the factor N above) in order to minimize the number of rays to track. If multiple rays are intercepted by the same surface, they are later scattered as a single point (or more, depending of the factor N above) in order to minimize the number of rays to track. Use sparse voxel data structure to accelerate DART simulations and reduce memeory usage. Use sparse voxel data structure to accelerate DART simulations and reduce memeory usage. When number of triangles inside a voxel is larger than or equal to this value, DART will use BVH tree to accelerate the ray-triangles intersection test. When number of triangles inside a voxel is larger than or equal to this value, DART will use BVH tree to accelerate the ray- triangles intersection test.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
albedoThreshold
distanceBetweenIlluminationSubCenters
illuminationRepartitionMode
isInterceptedPowerPerDirectionForSpecularCheck
lightPropagationThreshold
maxNbSceneCrossing
member_data_items_
nbSubSubcenterTurbidEmission
nbSubcenterVolume
nbTrianglesWithinVoxelAcceleration
sparseVoxelAcceleration
subFaceBarycenterEnabled
subFaceBarycenterSubdivision
subclass
superclass
surfaceBarycenterEnabled
thermalEmissionSurfaceSubdivision
tzoff_pattern

Class methods

Instance variables

albedoThreshold
distanceBetweenIlluminationSubCenters
illuminationRepartitionMode
isInterceptedPowerPerDirectionForSpecularCheck
lightPropagationThreshold
maxNbSceneCrossing
nbSubSubcenterTurbidEmission
nbSubcenterVolume
nbTrianglesWithinVoxelAcceleration
sparseVoxelAcceleration
subFaceBarycenterEnabled
subFaceBarycenterSubdivision
surfaceBarycenterEnabled
thermalEmissionSurfaceSubdivision

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_ExpertModeDartSn

class create_ExpertModeDartSn(
    lightPropagationThreshold=1e-07,
    albedoThreshold=0.001,
    distanceBetweenIlluminationSubCenters=0.1,
    maxNbSceneCrossing=1000,
    illuminationRepartitionMode=2,
    nbSubcenterVolume=2,
    subFaceBarycenterSubdivision=1,
    thermalEmissionSurfaceSubdivision=0.01,
    nbSubSubcenterTurbidEmission=40,
    isInterceptedPowerPerDirectionForSpecularCheck=0,
    subFaceBarycenterEnabled=1,
    surfaceBarycenterEnabled=1,
    sparseVoxelAcceleration=1,
    nbTrianglesWithinVoxelAcceleration=10
)

Any ray is discarded if its energy becomes less than {"Threshold" x "Mean energy /steradian" derived from iterations 1 and 2 x "Solid angle of the ray"} Any ray is discarded if its energy becomes less than {"Threshold" x "Mean energy /steradian" derived from iterations 1 and 2 x "Solid angle of the ray"} The DART run stops if the variation of scene albedo between consecutive iterations is less than the threshold The DART run stops if the variation of scene albedo between consecutive iterations is less than the threshold BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E If a ray travels through more scene than the specified value, it is stopped and its energy registered as lost. Notably useful to prevent rays parallel or quasi-parallel to the scene in infinite slope mode. If a ray travels through more scene than the specified value, it is stopped and its energy registered as lost. Notably useful to prevent rays parallel or quasi-parallel to the scene in infinite slope mode. To Write To Write Used to oversample within cell scattering and to set the number of radiation source points from each cell face in coordination with the factor M. - Each cell has N^3 sub-cells. There can be 1 scattering point per sub-cell (i.e., N³ scattering points / cell). Thus, a triangle can have m scattering points if it crosses m sub-cells. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to oversample within cell scattering and to set the number of radiation source points from each cell face in coordination with the factor M. - Each cell has N^3 sub-cells. There can be 1 scattering point per sub-cell (i.e., N³ scattering points / cell). Thus, a triangle can have m scattering points if it crosses m sub-cells. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to set the number of radiation source points from each cell face in coordination with the factor N. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. Used to set the number of radiation source points from each cell face in coordination with the factor N. - Each cell face has N² * M² sub-faces. If multiple rays exit the same sub-face with the same direction, they are concatenated in a single ray. A ray will be emitted every S m2 during the thermal emission. A ray will be emitted every S m2 during the thermal emission. Thermal emission from a turbid cell arises from the center of each cell sub-face. It is equal to "Geometric factor G(ω)" x "Planck's radiance L(μ, cell temperature)". G(ω) is precomputed per cell sub-face as a numerical integral, using N² integration points per cell sub- face. Thermal emission from a turbid cell arises from the center of each cell sub-face. It is equal to "Geometric factor G(ω)" x "Planck's radiance L(μ, cell temperature)". G(ω) is precomputed per cell sub-face as a numerical integral, using N² integration points per cell sub-face. Specifies if the intercepted power per direction is stored for the specular reflection and refraction or not As the specular phenomenon is very directional, it is necessary to store the intercepted power per direction to well represent it. However, one can choose to well represent the first order of scattering and to assume the other as Lambertian. Specifies if the intercepted power per direction is stored for the specular reflection and refraction or not As the specular phenomenon is very directional, it is necessary to store the intercepted power per direction to well represent it. However, one can choose to well represent the first order of scattering and to assume the other as Lambertian. When multiple rays exit a cell through the same sub-face with the same direction, they are regrouped into a single ray in order to minimize tracking time. When multiple rays exit a cell through the same sub-face with the same direction, they are regrouped into a single ray in order to minimize tracking time. If multiple rays are intercepted by the same surface, they are later scattered as a single point (or more, depending of the factor N above) in order to minimize the number of rays to track. If multiple rays are intercepted by the same surface, they are later scattered as a single point (or more, depending of the factor N above) in order to minimize the number of rays to track. Use sparse voxel data structure to accelerate DART simulations and reduce memeory usage. Use sparse voxel data structure to accelerate DART simulations and reduce memeory usage. When number of triangles inside a voxel is larger than or equal to this value, DART will use BVH tree to accelerate the ray-triangles intersection test. When number of triangles inside a voxel is larger than or equal to this value, DART will use BVH tree to accelerate the ray- triangles intersection test.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
albedoThreshold
distanceBetweenIlluminationSubCenters
illuminationRepartitionMode
isInterceptedPowerPerDirectionForSpecularCheck
lightPropagationThreshold
maxNbSceneCrossing
member_data_items_
nbSubSubcenterTurbidEmission
nbSubcenterVolume
nbTrianglesWithinVoxelAcceleration
sparseVoxelAcceleration
subFaceBarycenterEnabled
subFaceBarycenterSubdivision
subclass
superclass
surfaceBarycenterEnabled
thermalEmissionSurfaceSubdivision
tzoff_pattern

Class methods

Instance variables

albedoThreshold
distanceBetweenIlluminationSubCenters
illuminationRepartitionMode
isInterceptedPowerPerDirectionForSpecularCheck
lightPropagationThreshold
maxNbSceneCrossing
nbSubSubcenterTurbidEmission
nbSubcenterVolume
nbTrianglesWithinVoxelAcceleration
sparseVoxelAcceleration
subFaceBarycenterEnabled
subFaceBarycenterSubdivision
surfaceBarycenterEnabled
thermalEmissionSurfaceSubdivision

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_ExpertModeLidar

class create_ExpertModeLidar(
    nbRandomPointsPerInteceptionAtmosphere=1
)

The number of signals sent back to the sensor of one interception within atmosphere. This is in order to reduce the signal noise of atmosphere, which comes from insufficient number of photons comparing to reality. The number of signals sent back to the sensor of one interception within atmosphere. This is in order to reduce the signal noise of atmosphere, which comes from insufficient number of photons comparing to reality.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
nbRandomPointsPerInteceptionAtmosphere
subclass
superclass
tzoff_pattern

Class methods

Instance variables

nbRandomPointsPerInteceptionAtmosphere

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(
    expertMode=0,
    nbThreads=4,
    useExternalScripts=0,
    ExpertModeDartFt=None,
    ExpertModeLidar=None,
    ExpertModeDartSn=None
)

Activation of new features in expert mode. Activation of new features in expert mode. DART will apply multi-threading to accelarate processing. It is implemented in illumination, scattering and atmosphere transfer function calculation. DART will apply multi-threading to accelarate processing. It is implemented in illumination, scattering and atmosphere transfer function calculation. Use external python script with DART processing Use external python script with DART processing

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ExpertModeDartFt
ExpertModeDartSn
ExpertModeLidar
Tag_strip_pattern_
expertMode
member_data_items_
nbThreads
subclass
superclass
tzoff_pattern
useExternalScripts

Class methods

Instance variables

ExpertModeDartFt
ExpertModeDartSn
ExpertModeLidar
expertMode
nbThreads
useExternalScripts

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_Etalement

class create_ExpertModeZone_Etalement(
    etalement=2,
    ExpertModeZone_Projection=None
)

ExpertModeZone_Etalement ExpertModeZone_Etalement The energy of rays reaching the image layer will be (or not) repartie in the pixels in function of the original figure's projection. The energy of rays reaching the image layer will be (or not) repartie in the pixels in function of the original figure's projection.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ExpertModeZone_Projection
Tag_strip_pattern_
etalement
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ExpertModeZone_Projection
etalement

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_Projection

class create_ExpertModeZone_Projection(
    keepNonProjectedImage=0
)

ExpertModeZone_Projection ExpertModeZone_Projection Select this option if you intend to resample your images (through the resampling tool). Another way to do it is to deactivate the projection in DART itself, and to use the tool to project (and resample) the generated horizontal images. Select this option if you intend to resample your images (through the resampling tool). Another way to do it is to deactivate the projection in DART itself, and to use the tool to project (and resample) the generated horizontal images.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
keepNonProjectedImage
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

keepNonProjectedImage

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_maskProjection

class create_ExpertModeZone_maskProjection(
    albedoImages=0
)

ExpertModeZone_maskProjection ExpertModeZone_maskProjection Irradiance, Exitance and Albedo images Irradiance, Exitance and Albedo images

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
albedoImages
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

albedoImages

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_ExternalScript

class create_ExternalScript(
    ScriptDefinition=None,
    ScriptLaunchPosition=None
)

Python External Script Python External Script

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ScriptDefinition
ScriptLaunchPosition
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ScriptDefinition
ScriptLaunchPosition

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_ExternalScripts

class create_ExternalScripts(
    ExternalScript=None
)

Python External Scripts Python External Scripts

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ExternalScript
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ExternalScript

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_FieldOfView

class create_FieldOfView(
    aovWidth=32,
    aovHeight=18
)

Width angle Width angle Height angle Height angle

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
aovHeight
aovWidth
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

aovHeight
aovWidth

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_Finite

class create_Finite(
    atmosphereDimension=500
)

Finite atmosphere Finite atmosphere Set the XY dimension of the atmosphere volume and the XY dimension of the background surrounding the simulated scene. The atmosphere volume in our Monte Carlo modelling is a cube filled with atmosphere constituents (gases, aerosols, clouds), the default height Z of the cube is 50 km Set the XY dimension of the atmosphere volume and the XY dimension of the background surrounding the simulated scene. The atmosphere volume in our Monte Carlo modelling is a cube filled with atmosphere constituents (gases, aerosols, clouds), the default height Z of the cube is 50 km

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
atmosphereDimension
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atmosphereDimension

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_FluxTrackingBiDirectionalProducts

class create_FluxTrackingBiDirectionalProducts(
    sunlitPerTrianglePerCell=0,
    sunlitPerCell=0
)

Flux-tracking bi-directional products Flux-tracking bi-directional products Temperature per triangle per cell using the format x.y.z.i:sf;sb;a where x, y and z are the indices of the cell, i the indice of the triangle, sf and sb the sunlit of the front and back respectively and a the area of the triangle within the cell. Temperature per triangle per cell using the format x.y.z.i:sf;sb;a where x, y and z are the indices of the cell, i the indice of the triangle, sf and sb the sunlit of the front and back respectively and a the area of the triangle within the cell. 3D array of fraction sunlit per cell 3D array of fraction sunlit per cell

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
sunlitPerCell
sunlitPerTrianglePerCell
superclass
tzoff_pattern

Class methods

Instance variables

sunlitPerCell
sunlitPerTrianglePerCell

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_FluxTrackingForwardProducts

class create_FluxTrackingForwardProducts(
    order1Products=0,
    allIterationsProducts=0,
    Order1Options=None
)

Flux-tracking forward products Flux-tracking forward products Create a Order1 directory which contains first order scattering products (BRF/BTF, radiative budget) Create a Order1 directory which contains first order scattering products (BRF/BTF, radiative budget) Results obtained at each iteration are stored or only first and last Iterations are stored Results obtained at each iteration are stored or only first and last Iterations are stored

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Order1Options
Tag_strip_pattern_
allIterationsProducts
member_data_items_
order1Products
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Order1Options
allIterationsProducts
order1Products

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_FluxTrackingModeProducts

class create_FluxTrackingModeProducts(
    brfProducts=1,
    temperaturePerTrianglePerCell=0,
    FluxTrackingForwardProducts=None,
    FluxTrackingBiDirectionalProducts=None,
    BrfProductsProperties=None
)

Reflectance and/or Brightness temperature products (images, etc.). Reflectance and/or Brightness temperature products (images, etc.). Temperature per triangle per cell using the format x.y.z.i:tf;tb;a where x, y and z are the indices of the cell, i the indice of the triangle, tf and tb the temperature of the front and back respectively and a the area of the triangle within the cell. Temperature per triangle per cell using the format x.y.z.i:tf;tb;a where x, y and z are the indices of the cell, i the indice of the triangle, tf and tb the temperature of the front and back respectively and a the area of the triangle within the cell.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BrfProductsProperties
FluxTrackingBiDirectionalProducts
FluxTrackingForwardProducts
Tag_strip_pattern_
brfProducts
member_data_items_
subclass
superclass
temperaturePerTrianglePerCell
tzoff_pattern

Class methods

Instance variables

BrfProductsProperties
FluxTrackingBiDirectionalProducts
FluxTrackingForwardProducts
brfProducts
temperaturePerTrianglePerCell

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_FluxtrackingSolarNoise

class create_FluxtrackingSolarNoise(
    nodefluxtracking=None,
    SpectralDomainTir=None,
    temperatureAtmosphere=None,
    nodeIlluminationMode=None
)

Solar Illumination (Flux Tracking) Solar Illumination (Flux Tracking)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SpectralDomainTir
Tag_strip_pattern_
member_data_items_
nodeIlluminationMode
nodefluxtracking
subclass
superclass
temperatureAtmosphere
tzoff_pattern

Class methods

Instance variables

SpectralDomainTir
nodeIlluminationMode
nodefluxtracking
temperatureAtmosphere

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_FocaleDistance

class create_FocaleDistance(
    focaleDistance=0.05
)

Focal view Focal view Distance from the camera position to the light convergence point. Distance from the camera position to the light convergence point.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
focaleDistance
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

focaleDistance

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_FootPrintAndFOVDispersions

class create_FootPrintAndFOVDispersions(
    dispersionFootprint=0.0012,
    dispersionFOV=0.0015
)

Half angles Half angles Footprint Footprint Field of view Field of view

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
dispersionFOV
dispersionFootprint
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

dispersionFOV
dispersionFootprint

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_FootPrintAndFOVRadiuses

class create_FootPrintAndFOVRadiuses(
    rayonLidar_emission=12,
    rayonLidar_reception=15
)

Radii Radii Footprint Footprint Field of view Field of view

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
rayonLidar_emission
rayonLidar_reception
subclass
superclass
tzoff_pattern

Class methods

Instance variables

rayonLidar_emission
rayonLidar_reception

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_FrontSide

class create_FrontSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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_GaussianSigmaIllumination

class create_GaussianSigmaIllumination(
    gaussian_sigma_illu=0.368
)

It's used to compute the standard deviation of the LIDAR intensity Gaussian spatial distribution. It's used to compute the standard deviation of the LIDAR intensity Gaussian spatial distribution.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
gaussian_sigma_illu
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

gaussian_sigma_illu

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_Hemisphere

class create_Hemisphere(
    ZenithalRange=None,
    HemisphereImageResolution=None,
    SphereGeometry=None
)

Hemispherical Camera (Fisheye) Hemispherical Camera (Fisheye)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

HemisphereImageResolution
SphereGeometry
Tag_strip_pattern_
ZenithalRange
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

HemisphereImageResolution
SphereGeometry
ZenithalRange

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_HemisphereImageResolution

class create_HemisphereImageResolution(
    projectionMode=0,
    nbPixelsPerAxis=1000
)

Image Resolution Image Resolution In Polar mode, the zenith angle is proportionnal to the distance of a pixel from the center of the image. In Lambert-Azimuthal Equal-Area, the zenith follows a formula provided at https://en.wikipedia.org/wiki/Lambert_azimuthal_equal- area_projection. In Polar mode, the zenith angle is proportionnal to the distance of a pixel from the center of the image. In Lambert-Azimuthal Equal-Area, the zenith follows a formula provided at https://en.wikipedia.org/wiki/Lambert_azimuthal_equal- area_projection. Number of Pixels per Axis Number of Pixels per Axis

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
nbPixelsPerAxis
projectionMode
subclass
superclass
tzoff_pattern

Class methods

Instance variables

nbPixelsPerAxis
projectionMode

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_HemisphericalDome

class create_HemisphericalDome(
    dome_distance=0
)

Hemispherical dome Hemispherical dome Distance Distance

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
dome_distance
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

dome_distance

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_HorizontalDome

class create_HorizontalDome(
    dome_height=0
)

Horizontal dome Horizontal dome Height Height

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
dome_height
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

dome_height

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_HybridAtmosphereBRFMap

class create_HybridAtmosphereBRFMap(
    brfResolution=1,
    targetRayDensityPerDirection=50
)

To assess BOA exitance for RT coupling To assess BOA exitance for RT coupling BRF/BTF Map resolution BRF/BTF Map resolution Target sample density per direction (BRF,BTF) Target sample density per direction (BRF,BTF)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
brfResolution
member_data_items_
subclass
superclass
targetRayDensityPerDirection
tzoff_pattern

Class methods

Instance variables

brfResolution
targetRayDensityPerDirection

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_ImageBinaryProducts

class create_ImageBinaryProducts(
    ifOutputFirstOrderWaveform=1,
    ifOutputNonConvolveWaveform=1,
    ifOutputStaticSection=1,
    outputFloatFormat=1
)

Store the 1st order waveform of each pulse in the output binary file. The 1st order non-convolved waveform will be stored if checked in combination with the non-convolved option. Store the 1st order waveform of each pulse in the output binary file. The 1st order non-convolved waveform will be stored if checked in combination with the non-convolved option. Store the non- convolved waveform of each pulse in the output binary file. The 1st order non-convolved waveform will be stored if checked in combination with the 1st order option. Store the non-convolved waveform of each pulse in the output binary file. The 1st order non-convolved waveform will be stored if checked in combination with the 1st order option. Store the static section of each pulse in the output binary file. Store the static section of each pulse in the output binary file. Determine the precision with which the data for the waveform are stored. A better precision implies more space is used to store the data in the hard-drive. Determine the precision with which the data for the waveform are stored. A better precision implies more space is used to store the data in the hard-drive.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
ifOutputFirstOrderWaveform
ifOutputNonConvolveWaveform
ifOutputStaticSection
member_data_items_
outputFloatFormat
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ifOutputFirstOrderWaveform
ifOutputNonConvolveWaveform
ifOutputStaticSection
outputFloatFormat

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_ImageParameters

class create_ImageParameters(
    rangeResolutionDef=1,
    resolutionRange=3,
    resolutionAzimuth=3
)

ImageParameters ImageParameters Definition of the range (scanning axis) resolution. Definition of the range (scanning axis) resolution. Step on the scanning axis of the LIDAR. Step on the scanning axis of the LIDAR. Step on the movement axis of the LIDAR. Step on the movement axis of the LIDAR.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
rangeResolutionDef
resolutionAzimuth
resolutionRange
subclass
superclass
tzoff_pattern

Class methods

Instance variables

rangeResolutionDef
resolutionAzimuth
resolutionRange

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_ImageResolution

class create_ImageResolution(
    nbPixelsWidth=1280,
    nbPixelsHeight=720
)

Image resolution Image resolution Image width Image width Image height Image height

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
nbPixelsHeight
nbPixelsWidth
subclass
superclass
tzoff_pattern

Class methods

Instance variables

nbPixelsHeight
nbPixelsWidth

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_ImageSideIllumination

class create_ImageSideIllumination(
    sideIlluminationEnabled=0,
    disableThermalEmission=0,
    disableSolarIllumination=0,
    TopSide=None,
    BottomSide=None,
    RightSide=None,
    LeftSide=None,
    FrontSide=None,
    BackSide=None
)

Use precomputed side illumination in order to simulate environnement effect. Use precomputed side illumination in order to simulate environnement effect. Disable thermal emission. Disable thermal emission. Disable solar illumination. Both direct and diffuse. Disable solar illumination. Both direct and diffuse.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BackSide
BottomSide
FrontSide
LeftSide
RightSide
Tag_strip_pattern_
TopSide
disableSolarIllumination
disableThermalEmission
member_data_items_
sideIlluminationEnabled
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BackSide
BottomSide
FrontSide
LeftSide
RightSide
TopSide
disableSolarIllumination
disableThermalEmission
sideIlluminationEnabled

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_ImportedPulse

class create_ImportedPulse(
    pulseSpatialFile='Lidar_Files/Impulse_spatial.txt',
    resolution=1.0,
    offsetX=0.0,
    offsetY=0.0
)

ImportedPulse ImportedPulse Path to the impulse spatial file Path to the impulse spatial file Resolution of the matrix Resolution of the matrix Offset on the X axis Offset on the X axis Offset on the Y axis Offset on the Y axis

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
offsetX
offsetY
pulseSpatialFile
resolution
subclass
superclass
tzoff_pattern

Class methods

Instance variables

offsetX
offsetY
pulseSpatialFile
resolution

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_ImportedPulseTime

class create_ImportedPulseTime(
    pulseTimeFile='Lidar_Files/Impulse_time.txt'
)

Path to the impulse time file Path to the impulse time file

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
pulseTimeFile
subclass
superclass
tzoff_pattern

Class methods

Instance variables

pulseTimeFile

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_LaiProductsProperties

class create_LaiProductsProperties(
    nonEmptyCellsLayer=1,
    lai1DProducts=1,
    lai2DProducts=1,
    lai3DProducts=1
)

LaiProductsProperties LaiProductsProperties nonEmptyCellsLayer nonEmptyCellsLayer lai1DProducts lai1DProducts Image of LAI accumulated along the Z axis Image of LAI accumulated along the Z axis lai3DProducts lai3DProducts

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
lai1DProducts
lai2DProducts
lai3DProducts
member_data_items_
nonEmptyCellsLayer
subclass
superclass
tzoff_pattern

Class methods

Instance variables

lai1DProducts
lai2DProducts
lai3DProducts
nonEmptyCellsLayer

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_LaunchBetweenDartModules

class create_LaunchBetweenDartModules(
    betweenModules=1
)

Launch script between DART modules Launch script between DART modules Launch script between following DART modules Launch script between following DART modules

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
betweenModules
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

betweenModules

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_LeftSide

class create_LeftSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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_Lidar

class create_Lidar(
    simulateImage=0,
    simulateSolarNoise=0,
    PhotonCounting=None,
    RunningMode=None,
    FluxtrackingSolarNoise=None,
    PulseDuration=None,
    LidarGeometry=None,
    LidarIlluminationIntensity=None,
    LidarAcquisitionParameters=None
)

Image mode will generate multiple pulse across a defined area. The results are an image as well as a waveform for each pulse. Image mode will generate multiple pulse across a defined area. The results are an image as well as a waveform for each pulse. Check to simulate Solar Noise Check to simulate Solar Noise

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

FluxtrackingSolarNoise
LidarAcquisitionParameters
LidarGeometry
LidarIlluminationIntensity
PhotonCounting
PulseDuration
RunningMode
Tag_strip_pattern_
member_data_items_
simulateImage
simulateSolarNoise
subclass
superclass
tzoff_pattern

Class methods

Instance variables

FluxtrackingSolarNoise
LidarAcquisitionParameters
LidarGeometry
LidarIlluminationIntensity
PhotonCounting
PulseDuration
RunningMode
simulateImage
simulateSolarNoise

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_LidarAcquisitionParameters

class create_LidarAcquisitionParameters(
    freq_recepteur_signal_LIDAR=1,
    DART_simulation_identical=0,
    calculatorMaximumRAM=1000,
    LIDAR_filter=0
)

LidarAcquisitionParameters LidarAcquisitionParameters Duration of each measurement. A 1ns duration corresponds to a path of 30cm, which, at NADIR and for scattering order 1, corresponds to a 15cm altitude difference. Duration of each measurement. A 1ns duration corresponds to a path of 30cm, which, at NADIR and for scattering order 1, corresponds to a 15cm altitude difference. If this box is checked, successive LIDAR and Monte Carlo simulations give the same results. If this box is checked, successive LIDAR and Monte Carlo simulations give the same results. This information is used for a better management of RAM This information is used for a better management of RAM If checked the signal will be cut from first non-empty bin to last non-empty bin. If not, the signal length is defined by Maximum and Minimum stored distance If checked the signal will be cut from first non-empty bin to last non-empty bin. If not, the signal length is defined by Maximum and Minimum stored distance

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

DART_simulation_identical
LIDAR_filter
Tag_strip_pattern_
calculatorMaximumRAM
freq_recepteur_signal_LIDAR
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

DART_simulation_identical
LIDAR_filter
calculatorMaximumRAM
freq_recepteur_signal_LIDAR

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_LidarGeometry

class create_LidarGeometry(
    lsMode=0,
    display=1,
    sensorArea=0.1,
    beam_width=0.0,
    ifSetZeroDist=0,
    fp_fovDef=0,
    StWaveHeightRange=None,
    SensorAngles=None,
    CenterOnGround=None,
    ZeroDist=None,
    FootPrintAndFOVRadiuses=None,
    FootPrintAndFOVDispersions=None,
    ALS=None,
    TLS=None
)

LidarGeometry LidarGeometry Laser scaning mode Laser scaning mode The ground footprints are displayed on the 2D view. Yellow corresponds to the illumination and orange to the reception. This parameter has no effet on the simulation (GUI only). The ground footprints are displayed on the 2D view. Yellow corresponds to the illumination and orange to the reception. This parameter has no effet on the simulation (GUI only). Area of LIDAR sensor Area of LIDAR sensor Width of the beam Width of the beam Waveform storage range option Waveform storage range option Definition of Footprint and FOV Definition of Footprint and FOV

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ALS
CenterOnGround
FootPrintAndFOVDispersions
FootPrintAndFOVRadiuses
SensorAngles
StWaveHeightRange
TLS
Tag_strip_pattern_
ZeroDist
beam_width
display
fp_fovDef
ifSetZeroDist
lsMode
member_data_items_
sensorArea
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ALS
CenterOnGround
FootPrintAndFOVDispersions
FootPrintAndFOVRadiuses
SensorAngles
StWaveHeightRange
TLS
ZeroDist
beam_width
display
fp_fovDef
ifSetZeroDist
lsMode
sensorArea

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_LidarIlluminationIntensity

class create_LidarIlluminationIntensity(
    numberofPhotons=100000,
    isImportPulseSpatial=0,
    ImportedPulse=None,
    GaussianSigmaIllumination=None
)

LidarIlluminationIntensity LidarIlluminationIntensity -LIDAR: approximate number of photons emitted by the LIDAR -Monte Carlo: number of photons emitted per illumination cell. -LIDAR: approximate number of photons emitted by the LIDAR -Monte Carlo: number of photons emitted per illumination cell. Check this to import an impulse spatial file Check this to import an impulse spatial file

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

GaussianSigmaIllumination
ImportedPulse
Tag_strip_pattern_
isImportPulseSpatial
member_data_items_
numberofPhotons
subclass
superclass
tzoff_pattern

Class methods

Instance variables

GaussianSigmaIllumination
ImportedPulse
isImportPulseSpatial
numberofPhotons

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_LidarSinglePulseProducts

class create_LidarSinglePulseProducts(
    convolvedWaveform=1,
    groundSensorImage=0,
    photonInformations=0,
    photonImagePerBin=0,
    perSceneType=0
)

Convolved Waveform Convolved Waveform Photons ground image Photons ground image Photons informations (allows a 3D view of photon interactions in "view-LIDAR") Photons informations (allows a 3D view of photon interactions in "view-LIDAR") Photons images per bin (bi-directional only) Photons images per bin (bi-directional only) Per scene element type (ground, leaves, roof, ...) Per scene element type (ground, leaves, roof, ...)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
convolvedWaveform
groundSensorImage
member_data_items_
perSceneType
photonImagePerBin
photonInformations
subclass
superclass
tzoff_pattern

Class methods

Instance variables

convolvedWaveform
groundSensorImage
perSceneType
photonImagePerBin
photonInformations

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_LowerRight

class create_LowerRight(
    lowerRightX=20.0,
    lowerRightY=20,
    lowerRightZ=10
)

Lower right X Lower right X Lower right Y Lower right Y Lower right Z Lower right Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
lowerRightX
lowerRightY
lowerRightZ
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

lowerRightX
lowerRightY
lowerRightZ

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_LuxCoreRenderEngineParameters

class create_LuxCoreRenderEngineParameters(
    numberOfIteration=80,
    pixelSize=1,
    targetRayDensityPerPixel=50,
    maximumRenderingTime=60,
    periodicSaveMethod=1,
    nbSceneRepetition=1,
    atmosphericRadiativeTransfer=0,
    sampler=1,
    russianRouletteEnable=0,
    PeriodicSaveByTime=None,
    PeriodicSaveBySample=None,
    MetropolisSamplerProperties=None,
    SamplerProperties=None,
    RussianRouletteParameters=None,
    Atmosphere=None,
    HybridAtmosphereBRFMap=None,
    RadiativeBudget=None
)

DART accuracy depends on the number N_scat of scatterings that are simulated when tracing rays in the Earth scene and the atmosphere: N_scat DART accuracy depends on the number N_scat of scatterings that are simulated when tracing rays in the Earth scene and the atmosphere: N_scat Images dimensions are automatically adapted so that the whole scene is seen. Images dimensions are automatically adapted so that the whole scene is seen. Set to 0 to disable. The process will then stop if it reaches the time limit or if killed by the user. Set to 0 to disable. The process will then stop if it reaches the time limit or if killed by the user. Set to 0 to disable. The process will then stop if it reaches the ray density threshold or if killed by the user. Set to 0 to disable. The process will then stop if it reaches the ray density threshold or if killed by the user. DART results can be periodically saved with a period that is either a time interval or a number of samples / pixel DART results can be periodically saved with a period that is either a time interval or a number of samples / pixel The scene will be duplicated (2N+1)(2N+1) times. The higher the number of repetitions, the slower the process. Doesn't apply to isolated scene. The scene will be duplicated (2N+1)(2N+1) times. The higher the number of repetitions, the slower the process. Doesn't apply to isolated scene. Atmospheric Radiative Transfer mode: (1) Hybrid: atmosphere radiative transfer is computed on the fly or pre-computed by DART-FT. It supports all DART-FT atmospheric RT mode and BRF products (2) Monte Carlo: uniform Monte Carlo path tracing in the Earth-Atmosphere system. It supports only image simulation. Atmospheric Radiative Transfer mode: (1) Hybrid: atmosphere radiative transfer is computed on the fly or pre-computed by DART-FT. It supports all DART-FT atmospheric RT mode and BRF products (2) Monte Carlo: uniform Monte Carlo path tracing in the Earth-Atmosphere system. It supports only image simulation. Samples a position on the image (and lights) using the defined strategy. SOBOL is a quasi-random sampler that guarantees a uniform distribution even with low sample count. METROPOLIS is a random sampler favouring high radiance pixels. Samples a position on the image (and lights) using the defined strategy. SOBOL is a quasi-random sampler that guarantees a uniform distribution even with low sample count. METROPOLIS is a random sampler favouring high radiance pixels. Enable the RussianRoulette acceleration Enable the RussianRoulette acceleration

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Atmosphere
HybridAtmosphereBRFMap
MetropolisSamplerProperties
PeriodicSaveBySample
PeriodicSaveByTime
RadiativeBudget
RussianRouletteParameters
SamplerProperties
Tag_strip_pattern_
atmosphericRadiativeTransfer
maximumRenderingTime
member_data_items_
nbSceneRepetition
numberOfIteration
periodicSaveMethod
pixelSize
russianRouletteEnable
sampler
subclass
superclass
targetRayDensityPerPixel
tzoff_pattern

Class methods

Instance variables

Atmosphere
HybridAtmosphereBRFMap
MetropolisSamplerProperties
PeriodicSaveBySample
PeriodicSaveByTime
RadiativeBudget
RussianRouletteParameters
SamplerProperties
atmosphericRadiativeTransfer
maximumRenderingTime
nbSceneRepetition
numberOfIteration
periodicSaveMethod
pixelSize
russianRouletteEnable
sampler
targetRayDensityPerPixel

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_MaketForwardProducts

class create_MaketForwardProducts(
    coverRateProducts=0,
    MNEProducts=0,
    coverRateProductsProperties=None
)

Earth scene forward products Earth scene forward products Scene Builder calculates the total and per type cover area of the triangles in the scene (stored in the simulation.properties.txt) Scene Builder calculates the total and per type cover area of the triangles in the scene (stored in the simulation.properties.txt) MNEProducts MNEProducts

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

MNEProducts
Tag_strip_pattern_
coverRateProducts
coverRateProductsProperties
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

MNEProducts
coverRateProducts
coverRateProductsProperties

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_MetropolisSamplerProperties

class create_MetropolisSamplerProperties(
    largeMutationRate=0.4,
    maxConsecutiveReject=512,
    mutationRange=0.1
)

Probability that the sampler will move away from the area it is currently focusing on. Probability that the sampler will move away from the area it is currently focusing on. Maximum number of consecutive rejects of a small mutated path (due to similarity with the previous ones) before the sampler move away from the currently focused area. Maximum number of consecutive rejects of a small mutated path (due to similarity with the previous ones) before the sampler move away from the currently focused area. How far (as a fraction of the size of the image) the sampler can move away from the currently focused area. How far (as a fraction of the size of the image) the sampler can move away from the currently focused area.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
largeMutationRate
maxConsecutiveReject
member_data_items_
mutationRange
subclass
superclass
tzoff_pattern

Class methods

Instance variables

largeMutationRate
maxConsecutiveReject
mutationRange

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_MonteCarlo

class create_MonteCarlo(
    calculatorMaximumRAM=1000,
    numberofPhotons=10000
)

MonteCarlo MonteCarlo This information is used for a better management of RAM This information is used for a better management of RAM -LIDAR: approximate number of photons emitted by the LIDAR -Monte Carlo: number of photons emitted per illumination cell. -LIDAR: approximate number of photons emitted by the LIDAR -Monte Carlo: number of photons emitted per illumination cell.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
calculatorMaximumRAM
member_data_items_
numberofPhotons
subclass
superclass
tzoff_pattern

Class methods

Instance variables

calculatorMaximumRAM
numberofPhotons

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'
)

Scene environment: Optical property Scene environment: Optical property Type of optical property Type of optical property Optical property index Optical property index 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.phase.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_Order1Options

class create_Order1Options(
    order1Only=0,
    imagesOnly=0
)

Storage of intercepted radiation is disabled after order 1 scattering. Saves RAM usage and time. Storage of intercepted radiation is disabled after order 1 scattering. Saves RAM usage and time. Scattering/thermal emission only for directions for which images are created. May save up a lot of time. Scattering/thermal emission only for directions for which images are created. May save up a lot of time.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
imagesOnly
member_data_items_
order1Only
subclass
superclass
tzoff_pattern

Class methods

Instance variables

imagesOnly
order1Only

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_OrthoFOV

class create_OrthoFOV(
    width=1.28,
    height=0.72
)

Sensor FOV Sensor FOV Width FOV Width FOV Height FOV Height FOV

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
height
member_data_items_
subclass
superclass
tzoff_pattern
width

Class methods

Instance variables

height
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_Orthographic

class create_Orthographic(
    OrthoFOV=None,
    ImageResolution=None
)

Orthographic Camera Orthographic Camera

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImageResolution
OrthoFOV
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ImageResolution
OrthoFOV

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_Parallelepiped

class create_Parallelepiped(
    UpperLeft=None,
    LowerRight=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

LowerRight
Tag_strip_pattern_
UpperLeft
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

LowerRight
UpperLeft

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_PeriodicSaveBySample

class create_PeriodicSaveBySample(
    periodicSaveSample=50
)

DART checks every second the number of samples per pixel calculated If this number exceeds the defined target then a save iteration is triggered. The accuracy of the interval can depend on the chosen target and the execution speed DART checks every second the number of samples per pixel calculated If this number exceeds the defined target then a save iteration is triggered. The accuracy of the interval can depend on the chosen target and the execution speed

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
periodicSaveSample
subclass
superclass
tzoff_pattern

Class methods

Instance variables

periodicSaveSample

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_PeriodicSaveByTime

class create_PeriodicSaveByTime(
    periodicSaveTime=20
)

DART checks every second the number of samples per pixel calculated If the elapsed time exceeds the defined target then a save iteration is triggered. The accuracy of the interval can depend on the chosen target and the execution speed DART checks every second the number of samples per pixel calculated If the elapsed time exceeds the defined target then a save iteration is triggered. The accuracy of the interval can depend on the chosen target and the execution speed

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
periodicSaveTime
subclass
superclass
tzoff_pattern

Class methods

Instance variables

periodicSaveTime

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_Phase

class create_Phase(
    calculatorMethod=0,
    accelerationEngine=2,
    AtmosphereRadiativeTransfer=None,
    ExpertModeZone=None,
    DartInputParameters=None,
    EngineParameter=None,
    DartProduct=None,
    SensorImageSimulation=None,
    ExternalScripts=None
)

DART-Lux: passive RS and LiDAR with Monte Carlo bi-directional path tracing. DART-FT: passive RS with Flux Tracking (discrete ordinates). DART-RC: LiDAR with forward ray tracing (Monte Carlo

  • Flux tracking). Monte Carlo: passive RS with basic forward Monte Carlo ray tracing. DART-Lux: passive RS and LiDAR with Monte Carlo bi-directional path tracing. DART-FT: passive RS with Flux Tracking (discrete ordinates). DART-RC: LiDAR with forward ray tracing (Monte Carlo + Flux tracking). Monte Carlo: passive RS with basic forward Monte Carlo ray tracing. Prefer Bi-Directionnal for images and directionnal reflectance/temperature simulations. Prefer Forward for Radiative-Budget simulations. Prefer Bi-Directionnal for images and directionnal reflectance/temperature simulations. Prefer Forward for Radiative-Budget simulations.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

AtmosphereRadiativeTransfer
DartInputParameters
DartProduct
EngineParameter
ExpertModeZone
ExternalScripts
SensorImageSimulation
Tag_strip_pattern_
accelerationEngine
calculatorMethod
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AtmosphereRadiativeTransfer
DartInputParameters
DartProduct
EngineParameter
ExpertModeZone
ExternalScripts
SensorImageSimulation
accelerationEngine
calculatorMethod

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_PhotonCounting

class create_PhotonCounting(
    pcDef=0,
    PhotonCountingParam=None,
    DiscreteReturnParam=None
)

LiDAR Type LiDAR Type Select Type Select Type

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

DiscreteReturnParam
PhotonCountingParam
Tag_strip_pattern_
member_data_items_
pcDef
subclass
superclass
tzoff_pattern

Class methods

Instance variables

DiscreteReturnParam
PhotonCountingParam
pcDef

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_PhotonCountingParam

class create_PhotonCountingParam(
    darkCountRate=100,
    deadTime=2.5,
    quantEff=15
)

Single-photon detector Single-photon detector the detector's minimum count rate without light source the detector's minimum count rate without light source the period needed by the detector to recover from a detection event, before another photon can be detected the period needed by the detector to recover from a detection event, before another photon can be detected the probability to detect a photon that reaches the detector in the an aquisition period the probability to detect a photon that reaches the detector in the an aquisition period

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
darkCountRate
deadTime
member_data_items_
quantEff
subclass
superclass
tzoff_pattern

Class methods

Instance variables

darkCountRate
deadTime
quantEff

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_Pinhole

class create_Pinhole(
    fieldOfViewDefinition=0,
    SensorDimensions=None,
    FocaleDistance=None,
    FieldOfView=None,
    ImageResolution=None
)

Perspective Camera (Pinhole) Perspective Camera (Pinhole) Field Of View Definition Field Of View Definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

FieldOfView
FocaleDistance
ImageResolution
SensorDimensions
Tag_strip_pattern_
fieldOfViewDefinition
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

FieldOfView
FocaleDistance
ImageResolution
SensorDimensions
fieldOfViewDefinition

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_PositionGround

class create_PositionGround(
    x=20,
    y=20
)

PositionGround PositionGround X coordinate of the control point ground position X coordinate of the control point ground position Y coordinate of the control point ground position Y coordinate of the control point ground position

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.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_PulseDuration

class create_PulseDuration(
    pulse_energy=1,
    isImportPulseTime=0,
    SigmaDefinition=None,
    ImportedPulseTime=None
)

PulseDuration PulseDuration Energy of each pulse Energy of each pulse Check this to import an impulse time file Check this to import an impulse time file

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImportedPulseTime
SigmaDefinition
Tag_strip_pattern_
isImportPulseTime
member_data_items_
pulse_energy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ImportedPulseTime
SigmaDefinition
isImportPulseTime
pulse_energy

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_Pushbroom

class create_Pushbroom(
    flightPathDefinition=0,
    PushbroomAOV=None,
    PushbroomFlightPath=None,
    PushbroomFlightTarget=None,
    ImageResolution=None
)

Pushbroom Pushbroom Flight Path Definition Flight Path Definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImageResolution
PushbroomAOV
PushbroomFlightPath
PushbroomFlightTarget
Tag_strip_pattern_
flightPathDefinition
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ImageResolution
PushbroomAOV
PushbroomFlightPath
PushbroomFlightTarget
flightPathDefinition

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_PushbroomAOV

class create_PushbroomAOV(
    aovWidth=30
)

Angle of view (AOV) Angle of view (AOV) Path perpendicular Angle Of View (width) Path perpendicular Angle Of View (width)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
aovWidth
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

aovWidth

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_PushbroomFlightPath

class create_PushbroomFlightPath(
    pathAzimuthalDirection=25,
    pathTravelDistance=40
)

Flight path Flight path Azimuth Azimuth Travel Distance Travel Distance

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
pathAzimuthalDirection
pathTravelDistance
subclass
superclass
tzoff_pattern

Class methods

Instance variables

pathAzimuthalDirection
pathTravelDistance

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_PushbroomFlightTarget

class create_PushbroomFlightTarget(
    flightTargetX=5,
    flightTargetY=0,
    flightTargetZ=1.6
)

Flight Target Flight Target X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
flightTargetX
flightTargetY
flightTargetZ
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

flightTargetX
flightTargetY
flightTargetZ

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_RadiativeBudget

class create_RadiativeBudget(
    meshGrid=0.1,
    nbIncidentDirections=50,
    rayDensity=25,
    subZoneRB=0,
    SubZonesRB=None
)

One RB sample per grid volume for volumes and one RB sample per centroid of sub-facet (i.e., segmented facet per grid volume). One RB sample per grid volume for volumes and one RB sample per centroid of sub-facet (i.e., segmented facet per grid volume). Number of directions for sampling the radiation that is incident on surfaces (facet, face of voxel,..). Number of directions for sampling the radiation that is incident on surfaces (facet, face of voxel,..). Number of samples per incident direction per point of the surface for computing its irradiance. Number of samples per incident direction per point of the surface for computing its irradiance. Define a subzone to compute the radiative budget Define a subzone to compute the radiative budget

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SubZonesRB
Tag_strip_pattern_
member_data_items_
meshGrid
nbIncidentDirections
rayDensity
subZoneRB
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SubZonesRB
meshGrid
nbIncidentDirections
rayDensity
subZoneRB

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_RightSide

class create_RightSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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_RunningMode

class create_RunningMode(
    snMode=0,
    AirConfig=None
)

Solar noise running parameters Solar noise running parameters Running mode Running mode

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

AirConfig
Tag_strip_pattern_
member_data_items_
snMode
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AirConfig
snMode

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_RussianRouletteParameters

class create_RussianRouletteParameters(
    russianRouletteDepth=6,
    russianRouletteThreshold=0.5
)

The number of rebound after which the Russian Roulette is enabled. The number of rebound after which the Russian Roulette is enabled. The probability over which Russian Roulette is enabled. The probability over which Russian Roulette is enabled.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
russianRouletteDepth
russianRouletteThreshold
subclass
superclass
tzoff_pattern

Class methods

Instance variables

russianRouletteDepth
russianRouletteThreshold

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_SamplerProperties

class create_SamplerProperties(
    adaptativeStrength=0.0
)

Probability that the next sample will be in the same area if said area's radiance has not converged yet. Probability that the next sample will be in the same area if said area's radiance has not converged yet.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
adaptativeStrength
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

adaptativeStrength

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_ScriptDefinition

class create_ScriptDefinition(
    sourceAbsolutePath='script.py',
    arguments=''
)

Python Script definition Python Script definition Source script (.py) Source script (.py) Script arguments Script arguments

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
arguments
member_data_items_
sourceAbsolutePath
subclass
superclass
tzoff_pattern

Class methods

Instance variables

arguments
sourceAbsolutePath

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_ScriptLaunchPosition

class create_ScriptLaunchPosition(
    launchPosition=1,
    LaunchBetweenDartModules=None
)

Script location in DART process Script location in DART process Script position in DART process Script position in DART process

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

LaunchBetweenDartModules
Tag_strip_pattern_
launchPosition
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

LaunchBetweenDartModules
launchPosition

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_Sensor

class create_Sensor(
    sensorDisabled=0,
    sensorConfiguration=2,
    sensorName='Camera',
    customImageName=0,
    autoFOV=0,
    autoCropImage=0,
    keepOnlyCentralScene=0,
    SensorImageName=None,
    SensorAutoConfigParameters=None,
    SensorCommonConfiguration=None,
    SensorForwardParameters=None,
    SensorLuxCoreParameters=None,
    Pinhole=None,
    Hemisphere=None,
    Orthographic=None,
    Pushbroom=None
)

Sensor node Sensor node This camera won't be simulated. This camera won't be simulated. Mode Mode Sensor Name Sensor Name Defines a custom name for the image. If unchecked, an automatic generic name will be used instead (ima001, ima002 etc...). Defines a custom name for the image. If unchecked, an automatic generic name will be used instead (ima001, ima002 etc...). Finds the FOV that allows for the defined target to be entirely seen. This does NOT change anything other than the FOV. Finds the FOV that allows for the defined target to be entirely seen. This does NOT change anything other than the FOV. Removes horizontals and vertical bands on the images border that do not belong to the defined target. Removes horizontals and vertical bands on the images border that do not belong to the defined target. Removes pixels that do not belong to the defined target. Removes pixels that do not belong to the defined target.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Hemisphere
Orthographic
Pinhole
Pushbroom
SensorAutoConfigParameters
SensorCommonConfiguration
SensorForwardParameters
SensorImageName
SensorLuxCoreParameters
Tag_strip_pattern_
autoCropImage
autoFOV
customImageName
keepOnlyCentralScene
member_data_items_
sensorConfiguration
sensorDisabled
sensorName
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Hemisphere
Orthographic
Pinhole
Pushbroom
SensorAutoConfigParameters
SensorCommonConfiguration
SensorForwardParameters
SensorImageName
SensorLuxCoreParameters
autoCropImage
autoFOV
customImageName
keepOnlyCentralScene
sensorConfiguration
sensorDisabled
sensorName

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_SensorAngleDirection

class create_SensorAngleDirection(
    sensorDirectionTheta=98,
    sensorDirectionPhi=45
)

Viewing Angle (ZYZ) Viewing Angle (ZYZ) 0deg looks upward. 180deg looks downward. 0deg looks upward. 180deg looks downward. Phi (zyZ) Phi (zyZ)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorDirectionPhi
sensorDirectionTheta
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorDirectionPhi
sensorDirectionTheta

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_SensorAngles

class create_SensorAngles(
    sensorPhi=45,
    sensorTheta=30
)

Central view direction Central view direction Upward (from ground to sensor) Azimuth Angle of the LIDAR sensor, for reception. The opposite angles are used for emission. Upward (from ground to sensor) Azimuth Angle of the LIDAR sensor, for reception. The opposite angles are used for emission. Upward (from ground to sensor) Zenith Angle of the LIDAR sensor, for reception. The opposite angles are used for emission. Upward (from ground to sensor) Zenith Angle of the LIDAR sensor, for reception. The opposite angles are used for emission.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorPhi
sensorTheta
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorPhi
sensorTheta

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_SensorAutoConfigParameters

class create_SensorAutoConfigParameters(
    targetScene=0
)

Sensor Auto-Configuration Sensor Auto-Configuration Target Area for Auto-FOV, Auto-Crop and Keep-Only-Central-Scene options. Target Area for Auto-FOV, Auto-Crop and Keep-Only-Central-Scene options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
targetScene
tzoff_pattern

Class methods

Instance variables

targetScene

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_SensorCentralPosition

class create_SensorCentralPosition(
    sensorPosX=36,
    sensorPosY=36,
    sensorPosZ=1.6
)

Position for which the sky visibility check-up is performed Position for which the sky visibility check-up is performed X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorPosX
sensorPosY
sensorPosZ
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorPosX
sensorPosY
sensorPosZ

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_SensorCommonConfiguration

class create_SensorCommonConfiguration(
    directionDefinition=0,
    SensorOrientation=None,
    SensorPosition=None,
    CameraTarget=None,
    CameraAltitude=None,
    SensorView=None
)

Sensors Common Configuration Sensors Common Configuration Viewing Configuration Definition Viewing Configuration Definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CameraAltitude
CameraTarget
SensorOrientation
SensorPosition
SensorView
Tag_strip_pattern_
directionDefinition
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CameraAltitude
CameraTarget
SensorOrientation
SensorPosition
SensorView
directionDefinition

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_SensorDimensions

class create_SensorDimensions(
    width=0.064,
    height=0.036
)

Sensor dimensions Sensor dimensions Sensor width Sensor width Sensor height Sensor height

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
height
member_data_items_
subclass
superclass
tzoff_pattern
width

Class methods

Instance variables

height
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_SensorForwardParameters

class create_SensorForwardParameters(
    nbSceneRepetitionFT=0
)

UNDEFINED UNDEFINED Number of scene repetition (Forward mode) Number of scene repetition (Forward mode)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
nbSceneRepetitionFT
subclass
superclass
tzoff_pattern

Class methods

Instance variables

nbSceneRepetitionFT

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_SensorImageName

class create_SensorImageName(
    imageName='image1'
)

Image Name Image Name Image File Name Image File Name

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
imageName
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

imageName

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_SensorImageSimulation

class create_SensorImageSimulation(
    importMultipleSensors=0,
    SensorsImportation=None,
    Sensor=None,
    VisibilityCheckUp=None,
    BRFCamera=None
)

Simulating passive sensors looking downward Simulating passive sensors looking downward This option does not work with the following options of the DART frame camera: hemispherical camera, Angles of View that define the FOV, Tait-Bryan angles. This option does not work with the following options of the DART frame camera: hemispherical camera, Angles of View that define the FOV, Tait-Bryan angles.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BRFCamera
Sensor
SensorsImportation
Tag_strip_pattern_
VisibilityCheckUp
importMultipleSensors
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BRFCamera
Sensor
SensorsImportation
VisibilityCheckUp
importMultipleSensors

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_SensorLuxCoreParameters

class create_SensorLuxCoreParameters(
    targetRayDensityPerPixel=50
)

UNDEFINED UNDEFINED Target sample density per pixel Target sample density per pixel

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
targetRayDensityPerPixel
tzoff_pattern

Class methods

Instance variables

targetRayDensityPerPixel

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_SensorOrientation

class create_SensorOrientation(
    orientationAngle=0.0
)

Rotation around viewing direction Rotation around viewing direction Rotation angle Rotation angle

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
orientationAngle
subclass
superclass
tzoff_pattern

Class methods

Instance variables

orientationAngle

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_SensorPos

class create_SensorPos(
    sensorPosX=0,
    sensorPosY=0,
    sensorPosZ=1000
)

Sensor Sensor X coordinate of sensor X coordinate of sensor Y coordinate of sensor Y coordinate of sensor Z coordinate of sensor Z coordinate of sensor

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorPosX
sensorPosY
sensorPosZ
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorPosX
sensorPosY
sensorPosZ

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_SensorPosition

class create_SensorPosition(
    sensorPositionDefinition=0,
    sensorPosX=36,
    sensorPosY=36,
    sensorPosZ=1.6
)

Sensor position Sensor position Position definition Position definition X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorPosX
sensorPosY
sensorPosZ
sensorPositionDefinition
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorPosX
sensorPosY
sensorPosZ
sensorPositionDefinition

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_SensorView

class create_SensorView(
    viewDefinition=0,
    SensorViewDirection=None,
    SensorAngleDirection=None,
    CameraOrientYPR=None
)

Viewing Direction (From Sensor, toward target) Viewing Direction (From Sensor, toward target) Viewing Direction Definition Viewing Direction Definition

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CameraOrientYPR
SensorAngleDirection
SensorViewDirection
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
viewDefinition

Class methods

Instance variables

CameraOrientYPR
SensorAngleDirection
SensorViewDirection
viewDefinition

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_SensorViewDirection

class create_SensorViewDirection(
    sensorDirectionX=-0.7,
    sensorDirectionY=-0.7,
    sensorDirectionZ=0.15
)

Cartesian Direction Cartesian Direction X X Y Y Z Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sensorDirectionX
sensorDirectionY
sensorDirectionZ
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sensorDirectionX
sensorDirectionY
sensorDirectionZ

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_SensorsImportation

class create_SensorsImportation(
    fileN='sensors.txt'
)

Multiple-PH-camera sensor importation Multiple-PH-camera sensor importation File name File name

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
fileN
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

fileN

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_SideIlluminationFile

class create_SideIlluminationFile(
    sideIlluminationFileName='bottomZExitEnergy.bin'
)

Precomputed illumination file path. Precomputed illumination file path.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sideIlluminationFileName
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sideIlluminationFileName

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_SigmaDefinition

class create_SigmaDefinition(
    relative_power_of_pulse=0.5,
    half_pulse_duration=2,
    gaussian_pulse_cut=3
)

SigmaDefinition SigmaDefinition Relative power of the Gaussian pulse at which the pulse duration is specified. Classically the relative power is the half value of the Gaussian pulse. Relative power of the Gaussian pulse at which the pulse duration is specified. Classically the relative power is the half value of the Gaussian pulse. This half pulse duration is used to compute the Gaussian pulse standard deviation (sigma) This half pulse duration is used to compute the Gaussian pulse standard deviation (sigma) Half pulse duration Half pulse duration

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
gaussian_pulse_cut
half_pulse_duration
member_data_items_
relative_power_of_pulse
subclass
superclass
tzoff_pattern

Class methods

Instance variables

gaussian_pulse_cut
half_pulse_duration
relative_power_of_pulse

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_SpectralDomainTir

class create_SpectralDomainTir(
    temperatureMode=0,
    TemperatureFile=None,
    TriangleTemperatureFile=None,
    skylTemperature=None
)

SpectralDomainTir SpectralDomainTir Earth temperature is either assessed with a simulation in the visible, or it is simply derived from a file that gives temperature in every cell Earth temperature is either assessed with a simulation in the visible, or it is simply derived from a file that gives temperature in every cell

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
TemperatureFile
TriangleTemperatureFile
member_data_items_
skylTemperature
subclass
superclass
temperatureMode
tzoff_pattern

Class methods

Instance variables

TemperatureFile
TriangleTemperatureFile
skylTemperature
temperatureMode

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_SpectralIntervals

class create_SpectralIntervals(
    SpectralIntervalsProperties=None
)

Spectral intervals Spectral intervals

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SpectralIntervalsProperties
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SpectralIntervalsProperties

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_SpectralIntervalsProperties

class create_SpectralIntervalsProperties(
    deltaLambda=0.02,
    meanLambda=0.56,
    bandNumber=0,
    spectralDartMode=0,
    emissionLawNode=None
)

SpectralIntervalsProperties SpectralIntervalsProperties Bandwidth Bandwidth Central wavelength Central wavelength 0 for first band) Be sure that the spectral band number corresponds in modus operandi and in LUT generator ! 0 for first band) Be sure that the spectral band number corresponds in modus operandi and in LUT generator ! -Mode R : Source: Sun, results: Reflectance -Mode R+T: Source: Sun + thermal emission, Results: brightness temperature -Mode T: Source : thermal emission, Results : brightness temperature -Mode R : Source: Sun, results: Reflectance -Mode R+T: Source: Sun + thermal emission, Results: brightness temperature -Mode T: Source : thermal emission, Results : brightness temperature

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
bandNumber
deltaLambda
emissionLawNode
meanLambda
member_data_items_
spectralDartMode
subclass
superclass
tzoff_pattern

Class methods

Instance variables

bandNumber
deltaLambda
emissionLawNode
meanLambda
spectralDartMode

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_SpectralIrradiance

class create_SpectralIrradiance(
    CommonParameters=None,
    SpectralIrradianceValue=None
)

SpectralIrradiance SpectralIrradiance

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CommonParameters
SpectralIrradianceValue
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CommonParameters
SpectralIrradianceValue

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(
    bandNumber=0,
    irradiance=1000,
    Skyl=0
)

SpectralIrradianceValue SpectralIrradianceValue 0 for first band) Be sure that the spectral band number corresponds in modus operandi and in LUT generator ! 0 for first band) Be sure that the spectral band number corresponds in modus operandi and in LUT generator ! TOA spectral solar constant [W/m²/μm] TOA spectral solar constant [W/m²/μm] SKYL (atmospheric scattering of sun radiance) SKYL (atmospheric scattering of sun radiance)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Skyl
Tag_strip_pattern_
bandNumber
irradiance
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Skyl
bandNumber
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_SphereGeometry

class create_SphereGeometry(
    radius=0.1
)

Sphere Geometry Sphere Geometry Radius Radius

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
radius
subclass
superclass
tzoff_pattern

Class methods

Instance variables

radius

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_StWaveHeightRange

class create_StWaveHeightRange(
    photon_max_LIDAR=50,
    photon_min_LIDAR=50
)

LIDAR waveform is made by photons that have crossed a distance smaller than "2 x (Distance "Sensor-Scene Minimum Altitude" + Max range below Scene Minimum Altitude)" and larger than "2 x (Distance "Sensor-Scene Minimum Altitude" - Max range above Scene Minimum Altitude)" LIDAR waveform is made by photons that have crossed a distance smaller than "2 x (Distance "Sensor- Scene Minimum Altitude" + Max range below Scene Minimum Altitude)" and larger than "2 x (Distance "Sensor-Scene Minimum Altitude" - Max range above Scene Minimum Altitude)" LIDAR waveform is made by photons that have crossed a distance smaller than "2 x (Distance "Sensor-Scene Minimum Altitude" + Max range below Scene Minimum Altitude)" and larger than "2 x (Distance "Sensor-Scene Minimum Altitude" - Max range above Scene Minimum Altitude)" LIDAR waveform is made by photons that have crossed a distance smaller than "2 x (Distance "Sensor-Scene Minimum Altitude" + Max range below Scene Minimum Altitude)" and larger than "2 x (Distance "Sensor-Scene Minimum Altitude" - Max range above Scene Minimum Altitude)"

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
photon_max_LIDAR
photon_min_LIDAR
subclass
superclass
tzoff_pattern

Class methods

Instance variables

photon_max_LIDAR
photon_min_LIDAR

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_SubZonesRB

class create_SubZonesRB(
    Parallelepiped=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Parallelepiped
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Parallelepiped

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_Swath

class create_Swath(
    isSeparatePulsesImport=0,
    calculatedSwath=None,
    importedSwath=None
)

Swath Swath Import a file contains detailed separated pulses Import a file contains detailed separated pulses

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
calculatedSwath
importedSwath
isSeparatePulsesImport
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

calculatedSwath
importedSwath
isSeparatePulsesImport

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_TLS

class create_TLS(
    lidarPosX=360.82,
    lidarPosY=360.82,
    lidarPosZ=10,
    TLSRegion=None
)

TLS TLS Lidar position (X) Lidar position (X) Lidar position (Y) Lidar position (Y) Lidar position (Z) Lidar position (Z)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

TLSRegion
Tag_strip_pattern_
lidarPosX
lidarPosY
lidarPosZ
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

TLSRegion
lidarPosX
lidarPosY
lidarPosZ

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_TLSRegion

class create_TLSRegion(
    terresScanRange=None
)

TLS Region TLS Region

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
terresScanRange
tzoff_pattern

Class methods

Instance variables

terresScanRange

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_TemperatureFile

class create_TemperatureFile(
    temperatureFileName='temperatures.txt'
)

TemperatureFile TemperatureFile Name of the text file that contains temperatures of all cells of the scene Name of the text file that contains temperatures of all cells of the scene

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
temperatureFileName
tzoff_pattern

Class methods

Instance variables

temperatureFileName

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'
)

Scene environment: Temperature property Scene environment: Temperature property Temperature property index Temperature property index Temperature property name Temperature property name

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.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_TopSide

class create_TopSide(
    storeExitingEnergy=0,
    provideIllumination=0,
    disableOtherSideConnection=0,
    SideIlluminationFile=None
)

Store exiting energy on this side. Generates a binary file containing images per exiting direction. Store exiting energy on this side. Generates a binary file containing images per exiting direction. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Provide precomputed illumination file, as generated by the "Store exiting energy" option. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options. Disable connection on the other side in repetitive or infinite slope mode. If a ray exit on this side, it is stopped regarless of the other options.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SideIlluminationFile
Tag_strip_pattern_
disableOtherSideConnection
member_data_items_
provideIllumination
storeExitingEnergy
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SideIlluminationFile
disableOtherSideConnection
provideIllumination
storeExitingEnergy

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_TriangleTemperatureFile

class create_TriangleTemperatureFile(
    triangleTemperatureFileName='temperaturesPerTriangle.txt'
)

UNDEFINED UNDEFINED One temperature per line, in Kelvin. Each line corresponds to a triangle in the same order as in "triangles.txt". In order to properly used this option, it is advised to run Maket once and not rerun it afterward. Or to run specifically Maket with a single thread. One temperature per line, in Kelvin. Each line corresponds to a triangle in the same order as in "triangles.txt". In order to properly used this option, it is advised to run Maket once and not rerun it afterward. Or to run specifically Maket with a single thread.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
triangleTemperatureFileName
tzoff_pattern

Class methods

Instance variables

triangleTemperatureFileName

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_UpperLeft

class create_UpperLeft(
    upperLeftX=10,
    upperLeftY=10,
    upperLeftZ=0
)

Upper left X Upper left X Upper left Y Upper left Y Upper left Z Upper left Z

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
upperLeftX
upperLeftY
upperLeftZ

Class methods

Instance variables

upperLeftX
upperLeftY
upperLeftZ

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_UserDirectionFile

class create_UserDirectionFile(
    visibilityDirectionsDefinition=0,
    visibilityDirectionFilePath='directions.txt'
)

Custom Directions Custom Directions Definition of the directions in the text file. Each line in the file corresponds to a direction. In carthesian, X Y and Z values separated by a space character are expected. In spherical, zenithal and azimuthal values are expected. Definition of the directions in the text file. Each line in the file corresponds to a direction. In carthesian, X Y and Z values separated by a space character are expected. In spherical, zenithal and azimuthal values are expected. The path to the directions file. The path to the directions file.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
visibilityDirectionFilePath
visibilityDirectionsDefinition

Class methods

Instance variables

visibilityDirectionFilePath
visibilityDirectionsDefinition

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_VisibilityCheckUp

class create_VisibilityCheckUp(
    sensorDisabled=0,
    userVisibilityDirectionsFile=0,
    SensorCentralPosition=None,
    UserDirectionFile=None
)

Sky Visibility Check-Up Sky Visibility Check-Up UNDEFINED UNDEFINED If unchecked, directions defined in the Directions node will be used. Otherwise, they will be recovered from a text file provided. If unchecked, directions defined in the Directions node will be used. Otherwise, they will be recovered from a text file provided.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SensorCentralPosition
Tag_strip_pattern_
UserDirectionFile
member_data_items_
sensorDisabled
subclass
superclass
tzoff_pattern
userVisibilityDirectionsFile

Class methods

Instance variables

SensorCentralPosition
UserDirectionFile
sensorDisabled
userVisibilityDirectionsFile

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_WeightingParameters

class create_WeightingParameters(
    sceneAverageTemperatureForPonderation=300
)

Reflectance, and by extension emissivity, will be ponderated across the full bandwidth using the inversion of the Plank law of the provided temperature. Reflectance, and by extension emissivity, will be ponderated across the full bandwidth using the inversion of the Plank law of the provided temperature.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
sceneAverageTemperatureForPonderation
subclass
superclass
tzoff_pattern

Class methods

Instance variables

sceneAverageTemperatureForPonderation

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_ZenithalRange

class create_ZenithalRange(
    zenithMinimum=0,
    zenithMaximum=90
)

Zenithal Range Zenithal Range Minimum Minimum Maximum Maximum

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
zenithMaximum
zenithMinimum

Class methods

Instance variables

zenithMaximum
zenithMinimum

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_ZeroDist

class create_ZeroDist(
    referenceZeroDistance=-1.0,
    distBeforeRef=-1.0,
    distAfterRef=-1.0
)

Stored waveform distance range from LIDAR Stored waveform distance range from LIDAR Distance to reference point Distance to reference point Stored distance before reference point Stored distance before reference point Stored distance after reference point Stored distance after reference point

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
distAfterRef
distBeforeRef
member_data_items_
referenceZeroDistance
subclass
superclass
tzoff_pattern

Class methods

Instance variables

distAfterRef
distBeforeRef
referenceZeroDistance

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_areaMaketProductsProperties

class create_areaMaketProductsProperties(
    totalMaketArea=1,
    areaMaketPerType=0,
    areaMaket1DProducts=1,
    areaMaket3DProducts=1
)

areaMaketProductsProperties areaMaketProductsProperties Scene Builder creates 1 file containing total area of triangle for each cell. Scene Builder creates 1 file containing total area of triangle for each cell. Scene Builder creates 1 file per type containing the total area of triangle for each cell. Scene Builder creates 1 file per type containing the total area of triangle for each cell. Vertical profile Vertical profile 3D matrix 3D matrix

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
areaMaket1DProducts
areaMaket3DProducts
areaMaketPerType
member_data_items_
subclass
superclass
totalMaketArea
tzoff_pattern

Class methods

Instance variables

areaMaket1DProducts
areaMaket3DProducts
areaMaketPerType
totalMaketArea

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_calculatedSwath

class create_calculatedSwath(
    platformAzimuth=0.0,
    width=30,
    CenterBegin=None,
    CenterEnd=None,
    ControlPoint=None,
    ImageParameters=None
)

calculatedSwath calculatedSwath Platform azimuth: tilt of the scanning axis relative to the movement axis. Platform azimuth: tilt of the scanning axis relative to the movement axis. Swath width, perpendicular to the movement axis. Swath width, perpendicular to the movement axis.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CenterBegin
CenterEnd
ControlPoint
ImageParameters
Tag_strip_pattern_
member_data_items_
platformAzimuth
subclass
superclass
tzoff_pattern
width

Class methods

Instance variables

CenterBegin
CenterEnd
ControlPoint
ImageParameters
platformAzimuth
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_coverRateProductsProperties

class create_coverRateProductsProperties(
    totalMaketCoverRate=1,
    coverRatePerType=0,
    coverRatePrecision=0.1
)

coverRateProductsProperties coverRateProductsProperties Scene Builder stores the total ground cover in the simulation.properties.txt The value is accessible through the key [maket.groundCover.triangles.total] Scene Builder stores the total ground cover in the simulation.properties.txt The value is accessible through the key [maket.groundCover.triangles.total] Scene Builder stores the total ground cover per type in the simulation.properties.txt The value is accessible through the key [maket.groundCover.triangles.type/N/], where N is the index of the type. The list of type are accessible in the dart.typ file in the input directory. Scene Builder stores the total ground cover per type in the simulation.properties.txt The value is accessible through the key [maket.groundCover.triangles.type/N/], where N is the index of the type. The list of type are accessible in the dart.typ file in the input directory. "Effective horizontal sample grid" "Effective horizontal sample grid"

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
coverRatePerType
coverRatePrecision
member_data_items_
subclass
superclass
totalMaketCoverRate
tzoff_pattern

Class methods

Instance variables

coverRatePerType
coverRatePrecision
totalMaketCoverRate

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_dartModuleProducts

class create_dartModuleProducts(
    CommonProducts=None,
    FluxTrackingModeProducts=None,
    LidarSinglePulseProducts=None,
    lidarALSMultiPulseWaveformProducts=None,
    lidarTLSMultiPulseWaveformProducts=None,
    lidarALSMultiPulseDiscreteReturnOrPhotonCountingProducts=None,
    lidarTLSMultiPulseDiscreteReturnOrPhotonCountingProducts=None
)

dartModuleProducts dartModuleProducts

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

CommonProducts
FluxTrackingModeProducts
LidarSinglePulseProducts
Tag_strip_pattern_
lidarALSMultiPulseDiscreteReturnOrPhotonCountingProducts
lidarALSMultiPulseWaveformProducts
lidarTLSMultiPulseDiscreteReturnOrPhotonCountingProducts
lidarTLSMultiPulseWaveformProducts
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CommonProducts
FluxTrackingModeProducts
LidarSinglePulseProducts
lidarALSMultiPulseDiscreteReturnOrPhotonCountingProducts
lidarALSMultiPulseWaveformProducts
lidarTLSMultiPulseDiscreteReturnOrPhotonCountingProducts
lidarTLSMultiPulseWaveformProducts

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_emissionLawNode

class create_emissionLawNode(
    emissionLaw=1
)

emissionLawNode emissionLawNode Thermal emission : Planck integrated on 1000 steps or Boltzmann (sigmaT^4) (in that case, the spectral band is only used to compute optical properties) Thermal emission : Planck integrated on 1000 steps or Boltzmann (sigmaT^4) (in that case, the spectral band is only used to compute optical properties)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
emissionLaw
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

emissionLaw

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_ftiImportation

class create_ftiImportation(
    ftiFileName='atmosphere_transfer_function_from_MA.binary'
)

Mid-Atmosphere transfer function Mid-Atmosphere transfer function Transfer function file name Transfer function file name

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
ftiFileName
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ftiFileName

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_illumination

class create_illumination(
    illuminationFileName='atmosphere_radiance_before_coupling.binary'
)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
illuminationFileName
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

illuminationFileName

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_importedSwath

class create_importedSwath(
    separatePulsesFile='Lidar_Files/Swath_ALS.txt',
    ApproximatedTrajectory=None
)

Importation Importation The separated pulses file The separated pulses file

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ApproximatedTrajectory
Tag_strip_pattern_
member_data_items_
separatePulsesFile
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ApproximatedTrajectory
separatePulsesFile

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',
    weightAtmosphereParameters=1,
    weightReflectanceParameters=1,
    WeightingParameters=None
)

Irradiance database Irradiance database Reflectance database Reflectance database Irradiance table Irradiance table Irradiance model Irradiance model Weighting of atmospheric parameters by the solar spectrum for the computation of per band mean values. Weighting of atmospheric parameters by the solar spectrum for the computation of per band mean values. Weighting of reflectance parameters by the solar spectrum for the computation of per band mean values. Weighting of reflectance parameters by the solar spectrum for the computation of per band mean values.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
WeightingParameters
databaseName
irradianceColumn
irradianceTable
member_data_items_
subclass
superclass
tzoff_pattern
weightAtmosphereParameters
weightReflectanceParameters

Class methods

Instance variables

WeightingParameters
databaseName
irradianceColumn
irradianceTable
weightAtmosphereParameters
weightReflectanceParameters

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_lidarALSMultiPulseDiscreteReturnOrPhotonCountingProducts

class create_lidarALSMultiPulseDiscreteReturnOrPhotonCountingProducts(
    lidarImagePanelInformation=1,
    groundSensorImage=0,
    detectedPoints=1,
    perSceneType=0
)

Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Photons ground image Photons ground image Detected discrete points Detected discrete points Per scene element type (ground, leaves, roof, ...) Per scene element type (ground, leaves, roof, ...)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
detectedPoints
groundSensorImage
lidarImagePanelInformation
member_data_items_
perSceneType
subclass
superclass
tzoff_pattern

Class methods

Instance variables

detectedPoints
groundSensorImage
lidarImagePanelInformation
perSceneType

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_lidarALSMultiPulseWaveformProducts

class create_lidarALSMultiPulseWaveformProducts(
    lidarImagePanelInformation=1,
    groundSensorImage=0,
    photonInformations=0,
    photonImagePerBin=0,
    perSceneType=0,
    ImageBinaryProducts=None
)

Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Photons ground image Photons ground image Photons informations (allows a 3D view of photon interactions in "view- LIDAR") Photons informations (allows a 3D view of photon interactions in "view-LIDAR") Photons images per bin (bi- directional only) Photons images per bin (bi-directional only) Per scene element type (ground, leaves, roof, ...) Per scene element type (ground, leaves, roof, ...)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImageBinaryProducts
Tag_strip_pattern_
groundSensorImage
lidarImagePanelInformation
member_data_items_
perSceneType
photonImagePerBin
photonInformations
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ImageBinaryProducts
groundSensorImage
lidarImagePanelInformation
perSceneType
photonImagePerBin
photonInformations

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_lidarTLSMultiPulseDiscreteReturnOrPhotonCountingProducts

class create_lidarTLSMultiPulseDiscreteReturnOrPhotonCountingProducts(
    lidarImagePanelInformation=1,
    detectedPoints=1,
    perSceneType=0
)

Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Detected discrete points Detected discrete points Per scene element type (ground, leaves, roof, ...) Per scene element type (ground, leaves, roof, ...)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
detectedPoints
lidarImagePanelInformation
member_data_items_
perSceneType
subclass
superclass
tzoff_pattern

Class methods

Instance variables

detectedPoints
lidarImagePanelInformation
perSceneType

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_lidarTLSMultiPulseWaveformProducts

class create_lidarTLSMultiPulseWaveformProducts(
    lidarImagePanelInformation=1,
    photonInformations=0,
    photonImagePerBin=0,
    perSceneType=0,
    ImageBinaryProducts=None
)

Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Generate Lidar_image_panel.txt, which is used by DART LiDAR viewer. Photons informations (allows a 3D view of photon interactions in "view-LIDAR") Photons informations (allows a 3D view of photon interactions in "view-LIDAR") Photons images per bin (bi-directional only) Photons images per bin (bi-directional only) Per scene element type (ground, leaves, roof, ...) Per scene element type (ground, leaves, roof, ...)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

ImageBinaryProducts
Tag_strip_pattern_
lidarImagePanelInformation
member_data_items_
perSceneType
photonImagePerBin
photonInformations
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ImageBinaryProducts
lidarImagePanelInformation
perSceneType
photonImagePerBin
photonInformations

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_maketModuleProducts

class create_maketModuleProducts(
    laiProducts=0,
    areaMaketProducts=0,
    objectGeneration=0,
    MaketForwardProducts=None,
    areaMaketProductsProperties=None,
    LaiProductsProperties=None
)

maketModuleProducts maketModuleProducts 3D and 1D distribution of LAI, and number of non empty cells per layer. These are products directly derived from the processing of the scene simulation. 3D and 1D distribution of LAI, and number of non empty cells per layer. These are products directly derived from the processing of the scene simulation. Scene Builder calculates the total and per type area of the triangles in the scene in each cell (and gives the results in a file) Scene Builder calculates the total and per type area of the triangles in the scene in each cell (and gives the results in a file) Generate a .obj file of the DSM. Generate a .obj file of the DSM.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

LaiProductsProperties
MaketForwardProducts
Tag_strip_pattern_
areaMaketProducts
areaMaketProductsProperties
laiProducts
member_data_items_
objectGeneration
subclass
superclass
tzoff_pattern

Class methods

Instance variables

LaiProductsProperties
MaketForwardProducts
areaMaketProducts
areaMaketProductsProperties
laiProducts
objectGeneration

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_nodeIlluminationMode

class create_nodeIlluminationMode(
    irradianceMode=0,
    irradianceDatabaseNode=None,
    BandIrradianceFileNode=None,
    illumination=None,
    ftiImportation=None,
    SpectralIrradiance=None
)

nodeIlluminationMode nodeIlluminationMode - "TOA: Irradiance spectra": Atmosphere radiative transfer gives BOA irradiance. - "TOA: Irradiance spectra": Atmosphere radiative transfer gives BOA irradiance.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

BandIrradianceFileNode
SpectralIrradiance
Tag_strip_pattern_
ftiImportation
illumination
irradianceDatabaseNode
irradianceMode
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

BandIrradianceFileNode
SpectralIrradiance
ftiImportation
illumination
irradianceDatabaseNode
irradianceMode

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_nodefluxtracking

class create_nodefluxtracking(
    numberOfIteration=20
)

nodefluxtracking nodefluxtracking This number is important: a too small value leads to inaccurate results, and a too large value leads to exact results with unnecessary large computer time. The optimal value depends on the spectral domain and landscape. For spectral bands with large scattering, a number larger than 20 may be needed. This number is important: a too small value leads to inaccurate results, and a too large value leads to exact results with unnecessary large computer time. The optimal value depends on the spectral domain and landscape. For spectral bands with large scattering, a number larger than 20 may be needed.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
numberOfIteration
subclass
superclass
tzoff_pattern

Class methods

Instance variables

numberOfIteration

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_radiativeBudgetProperties

class create_radiativeBudgetProperties(
    fIRfARfSRfINTR1DProducts=1,
    fIRfARfSRfINTR2DProducts=1,
    fIRfARfSRfINTR3DProducts=1,
    extrapolation=1,
    budgetTotalParType=0,
    profileParType=0,
    budget2DParType=0,
    budget3DParType=0,
    budget3DParSurface=0,
    budgetUnitModeR=0,
    binaryFormat=0,
    Components=None
)

radiativeBudgetProperties radiativeBudgetProperties Vertical profiles of fractions of incident (fINCR), intercepted (fINTR), absorbed (fABSR) and scattered (fSCAR) radiation Vertical profiles of fractions of incident (fINCR), intercepted (fINTR), absorbed (fABSR) and scattered (fSCAR) radiation Images fINTR, fABSR, fSCAR per column per iteration Images fINTR, fABSR, fSCAR per column per iteration Horizontal sections xy, for each horizontal layer and each iteration, of fractions of incident (fINCR), intercepted (fINTR), absorbed (fABSR) and scattered (fSCAR) radiation Horizontal sections xy, for each horizontal layer and each iteration, of fractions of incident (fINCR), intercepted (fINTR), absorbed (fABSR) and scattered (fSCAR) radiation Extrapolation of radiation products Extrapolation of radiation products fINTR, fABSR, fSCAR total per type (triangles, turbid, ...) and per iteration fINTR, fABSR, fSCAR total per type (triangles, turbid, ...) and per iteration Vertical profiles IntR, AbsR, EmitR, ScaR per iteration and per type Vertical profiles IntR, AbsR, EmitR, ScaR per iteration and per type 2D images of fINTR, fABSR, fSCAR per column per iteration and per type 2D images of fINTR, fABSR, fSCAR per column per iteration and per type 3D fINTR, fABSR, fSCAR per iteration and per type of triangle 3D fINTR, fABSR, fSCAR per iteration and per type of triangle fINTR, fABSR, fSCAR total per individual triangle and per iteration. Can be displayed in the Surface Radiative Budget viewer, in the viewer tools. fINTR, fABSR, fSCAR total per individual triangle and per iteration. Can be displayed in the Surface Radiative Budget viewer, in the viewer tools. In T and R+T mode, "fraction" gives the same result as "W/mœ". In T and R+T mode, "fraction" gives the same result as "W/mœ". Output the large radiative budgets (3D or per individual triangles) to binary files instead of text files. Improves significatively the performance during the writing of these files. Output the large radiative budgets (3D or per individual triangles) to binary files instead of text files. Improves significatively the performance during the writing of these files.

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Components
Tag_strip_pattern_
binaryFormat
budget2DParType
budget3DParSurface
budget3DParType
budgetTotalParType
budgetUnitModeR
extrapolation
fIRfARfSRfINTR1DProducts
fIRfARfSRfINTR2DProducts
fIRfARfSRfINTR3DProducts
member_data_items_
profileParType
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Components
binaryFormat
budget2DParType
budget3DParSurface
budget3DParType
budgetTotalParType
budgetUnitModeR
extrapolation
fIRfARfSRfINTR1DProducts
fIRfARfSRfINTR2DProducts
fIRfARfSRfINTR3DProducts
profileParType

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_skylTemperature

class create_skylTemperature(
    SKYLForTemperatureAssignation=0.0,
    histogramThreshold=5.0,
    distanceBetweenIlluminationSubCenters=0.1
)

Used to define the illumination (VIS) in order to calculate scene temperatures Used to define the illumination (VIS) in order to calculate scene temperatures Temperatures are "uniformally" distributed between the Xth percentile and 100-Xth percentile IPARs. IPARS outside these percentile are given the minimum and maximum temperatures respectively. Temperatures are "uniformally" distributed between the Xth percentile and 100-Xth percentile IPARs. IPARS outside these percentile are given the minimum and maximum temperatures respectively. BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E BOA illumination is simulated with several sun and atmosphere rays per cell. Ray density is 1/D². With direct sun BOA irradiance Esun, atmosphere BOA irradiance Eatm (sun scattered + thermal emission), BOA irradiance E

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

SKYLForTemperatureAssignation
Tag_strip_pattern_
distanceBetweenIlluminationSubCenters
histogramThreshold
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

SKYLForTemperatureAssignation
distanceBetweenIlluminationSubCenters
histogramThreshold

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_temperatureAtmosphere

class create_temperatureAtmosphere(
    atmosphericApparentTemperature=288.0
)

Atmosphere Atmosphere Active in (T) and (R+T) for "No atmosphere RT" and "Analytic model" No active for "Radiative transfer simulation" Active in (T) and (R+T) for "No atmosphere RT" and "Analytic model" No active for "Radiative transfer simulation"

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
atmosphericApparentTemperature
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atmosphericApparentTemperature

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_terresScanRange

class create_terresScanRange(
    centerTheta=90,
    centerPhi=45,
    deltaTheta=10,
    deltaPhi=10,
    resTheta=1,
    resPhi=1
)

terresScanRange terresScanRange In degrees. The direction is defined from the target to the TLS. 0deg goes verticaly upward. In degrees. The direction is defined from the target to the TLS. 0deg goes verticaly upward. In degrees. The direction is defined from the target to the TLS. 0deg points toward the South in the 2D view. In degrees. The direction is defined from the target to the TLS. 0deg points toward the South in the 2D view. Zenithal range of acquisition. Zenithal range of acquisition. Azimuthal range of acquisition. Azimuthal range of acquisition. The grid of acquisition is (Delta zenith x Delta azimuth) / (Resolution zenith x Resolution azimuth) The grid of acquisition is (Delta zenith x Delta azimuth) / (Resolution zenith x Resolution azimuth) The grid of acquisition is (Delta zenith x Delta azimuth) / (Resolution zenith x Resolution azimuth) The grid of acquisition is (Delta zenith x Delta azimuth) / (Resolution zenith x Resolution azimuth)

Ancestors (in MRO)

  • pytools4dart.core_ui.phase.GeneratedsSuper

Class variables

Tag_strip_pattern_
centerPhi
centerTheta
deltaPhi
deltaTheta
member_data_items_
resPhi
resTheta
subclass
superclass
tzoff_pattern

Class methods

Instance variables

centerPhi
centerTheta
deltaPhi
deltaTheta
resPhi
resTheta

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