Skip to content

Module pytools4dart.core_ui.atmosphere

Classes

createDartFile

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

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Atmosphere
Tag_strip_pattern_
build_
member_data_items_
subclass
superclass
tzoff_pattern
version

Class methods

Instance variables

Atmosphere
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_Aerosol

class create_Aerosol(
    AerosolProperties=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

AerosolProperties
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AerosolProperties

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_AerosolProperties

class create_AerosolProperties(
    databaseName='dart_atmosphere.db',
    aerosolsModelName='USSTD76_RURALV23',
    aerosolCumulativeModelName='RURALV23',
    hgParametersModelName='RURALV23',
    aerosolOptDepthFactor=1
)

Reflectance database Reflectance database Aerosol model Aerosol model Aerosol cumulative model Aerosol cumulative model Henyey Greenstein parameters model Henyey Greenstein parameters model Aerosol optical depth of the database will be multiplied by these factor at every wavelength Aerosol optical depth of the database will be multiplied by these factor at every wavelength

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
aerosolCumulativeModelName
aerosolOptDepthFactor
aerosolsModelName
databaseName
hgParametersModelName
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

aerosolCumulativeModelName
aerosolOptDepthFactor
aerosolsModelName
databaseName
hgParametersModelName

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_Amount_atm_cm

class create_Amount_atm_cm(
    atm_cm=1762.3
)

Total amount in atm-cm Total amount in atm-cm Amount Amount

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
atm_cm
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atm_cm

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_Amount_g_per_cm2

class create_Amount_g_per_cm2(
    g_per_cm2=1.41
)

Total amount in g/cm2 Total amount in g/cm2 Amount Amount

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
g_per_cm2
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

g_per_cm2

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(
    isRadiativeTransfertInBottomAtmosphereDefined=0,
    Aerosol=None,
    IsAtmosphere=None
)

Atmosphere Atmosphere Radiative transfer is simulated within the air of the lower atmosphere (i.e., the earth landscape is within the lower atmosphere) Radiative transfer is simulated within the air of the lower atmosphere (i.e., the earth landscape is within the lower atmosphere)

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Aerosol
IsAtmosphere
Tag_strip_pattern_
isRadiativeTransfertInBottomAtmosphereDefined
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Aerosol
IsAtmosphere
isRadiativeTransfertInBottomAtmosphereDefined

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_AtmosphereComponents

class create_AtmosphereComponents(
    upwardingFluxes=0,
    downwardingFluxes=0
)

Atmosphere fluxes used to irradiate BOA scene and compute BOA products are defined here Atmosphere fluxes used to irradiate BOA scene and compute BOA products are defined here 1) None: TOA, Sensor and BOA irradiance irradiance has no component from Earth surface. 2) Diffuse: TOA, Sensor and BOA irradiance has 1 component due to the Earth surface: -Earth scene reflected/emitted radiation that is scattered by the atmosphere. 3) Direct: TOA, Sensor and BOA irradiance has 1 component due to the Earth surface: -Earth scene reflected/emitted radiation that is directly transmitted by the atmosphere, without absorption and scattering. 4) Total: TOA, Sensor and BOA irradiance has 2 component due to the Earth surface: -Earth scene reflected/emitted radiation that is scattered by the atmosphere. -Earth scene reflected/emitted radiation that is directly transmitted by the atmosphere, without absorption and scattering. 1) None: TOA, Sensor and BOA irradiance irradiance has no component from Earth surface. 2) Diffuse: TOA, Sensor and BOA irradiance has 1 component due to the Earth surface: -Earth scene reflected/emitted radiation that is scattered by the atmosphere. 3) Direct: TOA, Sensor and BOA irradiance has 1 component due to the Earth surface: -Earth scene reflected/emitted radiation that is directly transmitted by the atmosphere, without absorption and scattering. 4) Total: TOA, Sensor and BOA irradiance has 2 component due to the Earth surface: -Earth scene reflected/emitted radiation that is scattered by the atmosphere. -Earth scene reflected/emitted radiation that is directly transmitted by the atmosphere, without absorption and scattering. 1) Total: TOA, Sensor and BOA irradiance has 2 components due to downward sun radiation: -Sun radiation that is directly transmitted by the atmosphere , without absorption and scattering. - Direct sun radiation that is scattered by the atmosphere. There can be also atmosphere thermal emission and Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere. 2) Diffuse: TOA, Sensor and BOA irradiance has 1 components due to downward sun radiation: - Direct sun radiation that is scattered by the atmosphere. There can be also atmosphere thermal emission and Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere. 3) Direct:TOA, Sensor and BOA irradiance has 1 components due to downward sun radiation: -Sun radiation that is directly transmitted by the atmosphere , without absorption and scattering. There can be also Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere. 1) Total: TOA, Sensor and BOA irradiance has 2 components due to downward sun radiation: -Sun radiation that is directly transmitted by the atmosphere , without absorption and scattering. - Direct sun radiation that is scattered by the atmosphere. There can be also atmosphere thermal emission and Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere. 2) Diffuse: TOA, Sensor and BOA irradiance has 1 components due to downward sun radiation: - Direct sun radiation that is scattered by the atmosphere. There can be also atmosphere thermal emission and Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere. 3) Direct:TOA, Sensor and BOA irradiance has 1 components due to downward sun radiation: -Sun radiation that is directly transmitted by the atmosphere , without absorption and scattering. There can be also Earth scene reflected/emitted radiation that is possibly scattered and/or directly transmitted by the atmosphere.

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
downwardingFluxes
member_data_items_
subclass
superclass
tzoff_pattern
upwardingFluxes

Class methods

Instance variables

downwardingFluxes
upwardingFluxes

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_AtmosphereExpertModeZone

class create_AtmosphereExpertModeZone(
    extrapol_atmos=0,
    threshold_Atmos_scattering=0.0001,
    number_iterationMax=100
)

Extrapolation over the 3 last iterations at BOA, TOA and Sensor level for illumination computation Extrapolation over the 3 last iterations at BOA, TOA and Sensor level for illumination computation Scattering threshold for irradiation and for transfer function Scattering threshold for irradiation and for transfer function Maximum scattering iteration number Maximum scattering iteration number

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
extrapol_atmos
member_data_items_
number_iterationMax
subclass
superclass
threshold_Atmos_scattering
tzoff_pattern

Class methods

Instance variables

extrapol_atmos
number_iterationMax
threshold_Atmos_scattering

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_AtmosphereGeometry

class create_AtmosphereGeometry(
    heightOfSensor=3000,
    discretisationAtmos=1,
    minimumNumberOfDivisions=4,
    discretisationAtmosAuto=None,
    MidAtmosphere=None,
    UpperAtmosphere=None
)

AtmosphereGeometry AtmosphereGeometry With the -atmosphere RT + sensor- options, the Sensor layer altitude is used to compute atmosphere upward transmittance and path radiance from the Earth scene to the sensor. With the -atmosphere RT + sensor- options, the Sensor layer altitude is used to compute atmosphere upward transmittance and path radiance from the Earth scene to the sensor. If "Automatic", the layers number depends on total optical depth of the first spectral band If "Automatic", the layers number depends on total optical depth of the first spectral band Number of integration division for aerosol phase function Number of integration division for aerosol phase function

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

MidAtmosphere
Tag_strip_pattern_
UpperAtmosphere
discretisationAtmos
discretisationAtmosAuto
heightOfSensor
member_data_items_
minimumNumberOfDivisions
subclass
superclass
tzoff_pattern

Class methods

Instance variables

MidAtmosphere
UpperAtmosphere
discretisationAtmos
discretisationAtmosAuto
heightOfSensor
minimumNumberOfDivisions

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_AtmosphereIterations

class create_AtmosphereIterations(
    AtmosphereTransfertFunctions=None,
    AtmosphereProducts=None,
    AtmosphereComponents=None,
    AtmosphereExpertModeZone=None
)

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

AtmosphereComponents
AtmosphereExpertModeZone
AtmosphereProducts
AtmosphereTransfertFunctions
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

AtmosphereComponents
AtmosphereExpertModeZone
AtmosphereProducts
AtmosphereTransfertFunctions

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_AtmosphereProducts

class create_AtmosphereProducts(
    atmosphereRadiance_BOA_avantCouplage=0,
    atmosphereRadiance_BOA_apresCouplage=0,
    atmosphereBRF_TOA=0,
    ordreUnAtmos=0,
    atmosphereReport=0
)

Atmosphere products Atmosphere products atmosphere radiance BOA before coupling atmosphere radiance BOA before coupling atmosphere radiance BOA after coupling atmosphere radiance BOA after coupling atmosphere BRF TOA atmosphere BRF TOA Order 1 for atmosphere Order 1 for atmosphere Generate an atmosphere report per band Generate an atmosphere report per band

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
atmosphereBRF_TOA
atmosphereRadiance_BOA_apresCouplage
atmosphereRadiance_BOA_avantCouplage
atmosphereReport
member_data_items_
ordreUnAtmos
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atmosphereBRF_TOA
atmosphereRadiance_BOA_apresCouplage
atmosphereRadiance_BOA_avantCouplage
atmosphereReport
ordreUnAtmos

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_AtmosphereTransfertFunctions

class create_AtmosphereTransfertFunctions(
    inputOutputTransfertFunctions=0,
    ComputedTransferFunctions=None,
    ImportedTransferFunctions=None
)

Transfer functions file as input (no recomputation)/output Transfer functions file as input (no recomputation)/output

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

ComputedTransferFunctions
ImportedTransferFunctions
Tag_strip_pattern_
inputOutputTransfertFunctions
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ComputedTransferFunctions
ImportedTransferFunctions
inputOutputTransfertFunctions

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_AtmosphericOpticalProperty

class create_AtmosphericOpticalProperty(
    aerosolScaleFactor=1000,
    aerosolOpticalDepth=0.202,
    aerosolAlbedo=0.947,
    g1=0.79,
    g2=0.4,
    a_HG=0.95,
    gasOpticalDepth=0.049,
    gasScaleFactor=8400,
    transmittanceOfGases=0.75,
    courbureTerre=1,
    pointMilieu=1
)

Aerosol density is proportional to exp[-z/Ha] at altitude z Aerosol density is proportional to exp[-z/Ha] at altitude z It corresponds to aerosol scattering and absorbing processes It corresponds to aerosol scattering and absorbing processes Single scattering albedo. 1 if no absorption by aerosols. 0 if no scattering by aerosols Single scattering albedo. 1 if no absorption by aerosols. 0 if no scattering by aerosols g1 g1 g2 g2 Multiplicative factor of the Henyey Greenstein phase function Multiplicative factor of the Henyey Greenstein phase function Optical depth associated to gas scattering only, without absorption Optical depth associated to gas scattering only, without absorption Gas density is proportional to exp[-z/Hg] at altitude z Gas density is proportional to exp[-z/Hg] at altitude z Transmittance ([0 1]) of an atmosphere made of 100% absorbing gas only Transmittance ([0 1]) of an atmosphere made of 100% absorbing gas only Plane parallel / spherical atmosphere Plane parallel / spherical atmosphere Mid point correction for first order scattering Mid point correction for first order scattering

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
a_HG
aerosolAlbedo
aerosolOpticalDepth
aerosolScaleFactor
courbureTerre
g1
g2
gasOpticalDepth
gasScaleFactor
member_data_items_
pointMilieu
subclass
superclass
transmittanceOfGases
tzoff_pattern

Class methods

Instance variables

a_HG
aerosolAlbedo
aerosolOpticalDepth
aerosolScaleFactor
courbureTerre
g1
g2
gasOpticalDepth
gasScaleFactor
pointMilieu
transmittanceOfGases

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_AtmosphericOpticalPropertyModel

class create_AtmosphericOpticalPropertyModel(
    databaseName='dart_atmosphere.db',
    gasModelName='USSTD76',
    gasCumulativeModelName='USSTD76',
    temperatureModelName='USSTD76',
    gasGroup=1,
    precipitableWaterAmountCkeckbox=0,
    redefTemperature=0,
    correctionBandModel=1,
    co2MixRate=365.0,
    ignoreGasForExtrapolation=0,
    scaleOtherGases=0,
    ignoredGas=None,
    OtherGasesScale=None,
    WaterAmount=None,
    tempParameters=None
)

Atmospheric model Atmospheric model Atmospheric database name Atmospheric database name Gas model Gas model Gas cumulative model Gas cumulative model Gas temperature model Gas temperature model Same model for gas parameters Same model for gas parameters Define water vapour amount Define water vapour amount Redefine temperature profile up to 10km Redefine temperature profile up to 10km Band model correction in SOLAR domain: if Beer law is invalid (up_down transmittance total transmittance ^ 2 ), the extinction coefficients are corrected after the sun illumination stage Band model correction in SOLAR domain: if Beer law is invalid (up_down transmittance total transmittance ^ 2 ), the extinction coefficients are corrected after the sun illumination stage CO2 mixing rate CO2 mixing rate Gas -- Ignore gas for atmosphere extrapolation Gas -- Ignore gas for atmosphere extrapolation Manually define the amount of other gases Manually define the amount of other gases

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

OtherGasesScale
Tag_strip_pattern_
WaterAmount
co2MixRate
correctionBandModel
databaseName
gasCumulativeModelName
gasGroup
gasModelName
ignoreGasForExtrapolation
ignoredGas
member_data_items_
precipitableWaterAmountCkeckbox
redefTemperature
scaleOtherGases
subclass
superclass
tempParameters
temperatureModelName
tzoff_pattern

Class methods

Instance variables

OtherGasesScale
WaterAmount
co2MixRate
correctionBandModel
databaseName
gasCumulativeModelName
gasGroup
gasModelName
ignoreGasForExtrapolation
ignoredGas
precipitableWaterAmountCkeckbox
redefTemperature
scaleOtherGases
tempParameters
temperatureModelName

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_CellDimensions

class create_CellDimensions(
    xAI=100.0,
    yAI=100.0,
    zAI=500.0
)

Dimension in x of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in x of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in y of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in y of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in z of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Dimension in z of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
xAI
yAI
zAI

Class methods

Instance variables

xAI
yAI
zAI

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_ComputedTransferFunctions

class create_ComputedTransferFunctions(
    writeTransferFunctions=0
)

Write the computed transfer functions in a file that can be later reused by DART. See option just above. Write the computed transfer functions in a file that can be later reused by DART. See option just above.

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
writeTransferFunctions

Class methods

Instance variables

writeTransferFunctions

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_Density_RH_temp_altitude

class create_Density_RH_temp_altitude(
    rh=50.0,
    temp=288.15,
    altitude=0
)

Density in realtive humidity Density in realtive humidity Relative humidity Relative humidity Temperature Temperature Altitude Altitude

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
altitude
member_data_items_
rh
subclass
superclass
temp
tzoff_pattern

Class methods

Instance variables

altitude
rh
temp

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_Density_atm_cm_per_km_altitude

class create_Density_atm_cm_per_km_altitude(
    atm_cm_per_km=734.0,
    altitude=0
)

Density in atm-cm/km Density in atm-cm/km Density Density Altitude Altitude

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
altitude
atm_cm_per_km
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

altitude
atm_cm_per_km

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_Height

class create_Height(
    hCFAI=4000.0
)

Number of MA layers Number of MA layers

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
hCFAI
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

hCFAI

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_ImportedTransferFunctions

class create_ImportedTransferFunctions(
    transferFunctionsFile='atmosphereTransferFunctions.binary'
)

(Relative) file path to the precomputed transfer functions. This file can be generated by DART in "on the fly" mode. (Relative) file path to the precomputed transfer functions. This file can be generated by DART in "on the fly" mode.

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
transferFunctionsFile
tzoff_pattern

Class methods

Instance variables

transferFunctionsFile

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_IsAtmosphere

class create_IsAtmosphere(
    typeOfAtmosphere=1,
    isRadiativeTransfertInBottomAtmosphere=None,
    AtmosphericOpticalProperty=None,
    TemperatureFile=None,
    AtmosphericOpticalPropertyModel=None,
    AtmosphereIterations=None,
    AtmosphereGeometry=None
)

IsAtmosphere IsAtmosphere Choice of an atmosphere spectral database or user defined mono-spectral parameters for the atmosphere Choice of an atmosphere spectral database or user defined mono- spectral parameters for the atmosphere

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

AtmosphereGeometry
AtmosphereIterations
AtmosphericOpticalProperty
AtmosphericOpticalPropertyModel
Tag_strip_pattern_
TemperatureFile
isRadiativeTransfertInBottomAtmosphere
member_data_items_
subclass
superclass
typeOfAtmosphere
tzoff_pattern

Class methods

Instance variables

AtmosphereGeometry
AtmosphereIterations
AtmosphericOpticalProperty
AtmosphericOpticalPropertyModel
TemperatureFile
isRadiativeTransfertInBottomAtmosphere
typeOfAtmosphere

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_Layer

class create_Layer(
    zHA=2000.0
)

smaller computer times. smaller computer times.

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
zHA

Class methods

Instance variables

zHA

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_M_factor

class create_M_factor(
    mulFactorH2O=1.0
)

Multiplicative factor Multiplicative factor Multiplicative factor Multiplicative factor

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
member_data_items_
mulFactorH2O
subclass
superclass
tzoff_pattern

Class methods

Instance variables

mulFactorH2O

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_MidAtmosphere

class create_MidAtmosphere(
    CellDimensions=None,
    Height=None
)

Atmosphere Atmosphere

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

CellDimensions
Height
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CellDimensions
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_OtherGasesScale

class create_OtherGasesScale(
    coMulFactor=1,
    ch4MulFactor=1,
    n2oMulFactor=1,
    o2MulFactor=1,
    n2MulFactor=1,
    o3MulFactor=1,
    nh3MulFactor=1,
    noMulFactor=1,
    no2MulFactor=1,
    so2MulFactor=1,
    hno3MulFactor=1,
    othersMulFactor=1,
    scatMulFactor=1
)

Multiplicative factors for other gases' amounts Multiplicative factors for other gases' amounts CO CO CH4 CH4 N2O N2O O2 O2 N2 N2 O3 O3 NH3 NH3 NO NO NO2 NO2 SO2 SO2 HNO3 HNO3 Others Others Scattering Gases Scattering Gases

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
ch4MulFactor
coMulFactor
hno3MulFactor
member_data_items_
n2MulFactor
n2oMulFactor
nh3MulFactor
no2MulFactor
noMulFactor
o2MulFactor
o3MulFactor
othersMulFactor
scatMulFactor
so2MulFactor
subclass
superclass
tzoff_pattern

Class methods

Instance variables

ch4MulFactor
coMulFactor
hno3MulFactor
n2MulFactor
n2oMulFactor
nh3MulFactor
no2MulFactor
noMulFactor
o2MulFactor
o3MulFactor
othersMulFactor
scatMulFactor
so2MulFactor

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(
    atmosphereTemperatureFileName='atmosphereTemperature.txt'
)

File containing temperature vertical profile; example : number of layers 2 0 300 80 220 File necessary only in mode T or T+R File containing temperature vertical profile; example : number of layers 2 0 300 80 220 File necessary only in mode T or T+R

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
atmosphereTemperatureFileName
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

atmosphereTemperatureFileName

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_UpperAtmosphere

class create_UpperAtmosphere(
    hCFHA=80000.0,
    Layer=None
)

Atmosphere Atmosphere smaller computer times. smaller computer times.

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Layer
Tag_strip_pattern_
hCFHA
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Layer
hCFHA

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_WaterAmount

class create_WaterAmount(
    defWaterAmount=0,
    M_factor=None,
    Amount_g_per_cm2=None,
    Amount_atm_cm=None,
    Density_atm_cm_per_km_altitude=None,
    Density_RH_temp_altitude=None
)

Definition Definition

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Amount_atm_cm
Amount_g_per_cm2
Density_RH_temp_altitude
Density_atm_cm_per_km_altitude
M_factor
Tag_strip_pattern_
defWaterAmount
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

Amount_atm_cm
Amount_g_per_cm2
Density_RH_temp_altitude
Density_atm_cm_per_km_altitude
M_factor
defWaterAmount

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_discretisationAtmosAuto

class create_discretisationAtmosAuto(
    epsilon_atmos=0.003,
    gamma_atmos=0.95,
    xAI=400.0,
    yAI=400.0
)

leaf transmittance leaf transmittance Theoretical relative error on TOA reflectance to be found, resulting of atmosphere discretisation Theoretical relative error on TOA reflectance to be found, resulting of atmosphere discretisation percentage of MA contribution on BOA reflectance (for backscattering) percentage of MA contribution on BOA reflectance (for backscattering) Dimension in x of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in x of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in y of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y) Dimension in y of the MA cells Advice: Smaller cell dimensions and layer depth increase accuracy and computation time Better and faster results if the number of BA cells is a multiple of the number of MA cells (on x and y)

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
epsilon_atmos
gamma_atmos
member_data_items_
subclass
superclass
tzoff_pattern
xAI
yAI

Class methods

Instance variables

epsilon_atmos
gamma_atmos
xAI
yAI

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_fillH2O

class create_fillH2O(
    ifFillH2O=0,
    h2oDef=None
)

Fill in defined water vapor profile Fill in defined water vapor profile Define water vapor parameters at a point Define water vapor parameters at a point

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
h2oDef
ifFillH2O
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

h2oDef
ifFillH2O

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_h2oDef

class create_h2oDef(
    altitude=0,
    pressure=1013,
    rh=40,
    temp=273.15,
    dist=160
)

Parameters Parameters Altitude Altitude Pressure Pressure Relative humidity Relative humidity Temperature Temperature Distance to calculate reference cross-section Distance to calculate reference cross-section

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
altitude
dist
member_data_items_
pressure
rh
subclass
superclass
temp
tzoff_pattern

Class methods

Instance variables

altitude
dist
pressure
rh
temp

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_ignoredGas

class create_ignoredGas(
    H2O=0,
    O3=0,
    N2=0,
    CO2=0,
    CO=0,
    CH4=0,
    N2O=0,
    O2=0,
    NH3=0,
    NO=0,
    NO2=0,
    SO2=0,
    HNO3=0,
    fillH2O=None
)

Ignored gas Ignored gas H2O H2O O3 O3 N2 N2 CO2 CO2 CO CO CH4 CH4 N2O N2O O2 O2 NH3 NH3 NO NO NO2 NO2 SO2 SO2 HNO3 HNO3

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

CH4
CO
CO2
H2O
HNO3
N2
N2O
NH3
NO
NO2
O2
O3
SO2
Tag_strip_pattern_
fillH2O
member_data_items_
subclass
superclass
tzoff_pattern

Class methods

Instance variables

CH4
CO
CO2
H2O
HNO3
N2
N2O
NH3
NO
NO2
O2
O3
SO2
fillH2O

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_isRadiativeTransfertInBottomAtmosphere

class create_isRadiativeTransfertInBottomAtmosphere(
    BA_altitude=0,
    writeTemperatureFile=0
)

isRadiativeTransfertInBottomAtmosphere isRadiativeTransfertInBottomAtmosphere Altitude of the atmosphere up to which will be included in the BA level. Altitude of the atmosphere up to which will be included in the BA level. Output file name input/extrapolateAtmTemperatureVertical1D.txt Output file name input/extrapolateAtmTemperatureVertical1D.txt

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

BA_altitude
Tag_strip_pattern_
member_data_items_
subclass
superclass
tzoff_pattern
writeTemperatureFile

Class methods

Instance variables

BA_altitude
writeTemperatureFile

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_tempParameters

class create_tempParameters(
    temp=288.15,
    altitude=0
)

Temperature at the defined altitude Temperature at the defined altitude Temperature Temperature Altitude Altitude

Ancestors (in MRO)

  • pytools4dart.core_ui.atmosphere.GeneratedsSuper

Class variables

Tag_strip_pattern_
altitude
member_data_items_
subclass
superclass
temp
tzoff_pattern

Class methods

Instance variables

altitude
temp

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