Skip to content

API Reference

integrated_photon_sterance(T, x_ab, *, spectral_unit, area_unit)

Integrated photon sterance

Parameters:

Name Type Description Default
T ArrayLike

blackbody temperature (K)

 required
x_ab ArrayLike

spectral interval in units of spectral_unit

 required
spectral_unit str

units of the spectral variable

 required
area_unit str

units of the area element

 required

Returns:

Type Description
NDArray[float64]

integrated photon sterance
Source code in src/blackbody/__init__.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
@check_arguments_integrated
def integrated_photon_sterance(T, x_ab, *, spectral_unit, area_unit):
    """
    Integrated photon sterance

    Arguments:
        T: blackbody temperature (K)
        x_ab: spectral interval in units of `spectral_unit`
        spectral_unit: units of the spectral variable
        area_unit: units of the area element

    Returns:
        integrated photon sterance
    """
    (c1, c2) = RADIATION_CONSTANTS[('photon', spectral_unit)]

    _integrated_planck_distribution = INTEGRATED_PLANCK_DISTRIBUTIONS[('photon', spectral_unit)]

    i1 = _integrated_planck_distribution(c1, c2, T, x_ab[..., 0])
    i2 = _integrated_planck_distribution(c1, c2, T, x_ab[..., 1])

    return np.abs(i2-i1)*AREA_FACTORS[area_unit]

integrated_radiant_sterance(T, x_ab, *, spectral_unit, area_unit)

Integrated radiant sterance

Parameters:

Name Type Description Default
T ArrayLike

blackbody temperature (K)

 required
x_ab ArrayLike

spectral interval in units of spectral_unit

 required
spectral_unit str

units of the spectral variable

 required
area_unit str

units of the area element

 required

Returns:

Type Description
NDArray[float64]

integrated radiant sterance
Source code in src/blackbody/__init__.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@check_arguments_integrated
def integrated_radiant_sterance(T, x_ab, *, spectral_unit, area_unit):
    """
    Integrated radiant sterance

    Arguments:
        T: blackbody temperature (K)
        x_ab: spectral interval in units of `spectral_unit`
        spectral_unit: units of the spectral variable
        area_unit: units of the area element

    Returns:
        integrated radiant sterance
    """
    (c1, c2) = RADIATION_CONSTANTS[('energy', spectral_unit)]

    _integrated_planck_distribution = INTEGRATED_PLANCK_DISTRIBUTIONS[('energy', spectral_unit)]

    i1 = _integrated_planck_distribution(c1, c2, T, x_ab[..., 0])
    i2 = _integrated_planck_distribution(c1, c2, T, x_ab[..., 1])

    return np.abs(i2-i1)*AREA_FACTORS[area_unit]

spectral_photon_sterance(T, x, *, spectral_unit, area_unit)

Spectral photon sterance

Parameters:

Name Type Description Default
T ArrayLike

blackbody temperature (K)

 required
x ArrayLike

spectral variable in units of spectral_unit

 required
spectral_unit str

units of the spectral variable

 required
area_unit str

units of the area element

 required

Returns:

Type Description
NDArray[float64]

spectral photon sterance
Source code in src/blackbody/__init__.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@check_arguments_spectral
def spectral_photon_sterance(T, x, *, spectral_unit, area_unit):
    """
    Spectral photon sterance

    Arguments:
        T: blackbody temperature (K)
        x: spectral variable in units of `spectral_unit`
        spectral_unit: units of the spectral variable
        area_unit: units of the area element

    Returns:
        spectral photon sterance

    """
    (c1, c2) = RADIATION_CONSTANTS[('photon', spectral_unit)]

    _planck_distribution = PLANCK_DISTRIBUTIONS[('photon', spectral_unit)]

    return _planck_distribution(c1, c2, T, x)*AREA_FACTORS[area_unit]

spectral_radiant_sterance(T, x, *, spectral_unit, area_unit)

Spectral radiant sterance

Parameters:

Name Type Description Default
T ArrayLike

blackbody temperature (K)

 required
x ArrayLike

spectral variable in units of spectral_unit

 required
spectral_unit str

units of the spectral variable

 required
area_unit str

units of the area element

 required

Returns:

Type Description
NDArray[float64]

spectral radiant sterance
Source code in src/blackbody/__init__.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
@check_arguments_spectral
def spectral_radiant_sterance(T, x, *, spectral_unit, area_unit):
    """
    Spectral radiant sterance

    Arguments:
        T: blackbody temperature (K)
        x: spectral variable in units of `spectral_unit`
        spectral_unit: units of the spectral variable
        area_unit: units of the area element

    Returns:
        spectral radiant sterance
    """
    (c1, c2) = RADIATION_CONSTANTS[('energy', spectral_unit)]

    _planck_distribution = PLANCK_DISTRIBUTIONS[('energy', spectral_unit)]

    return _planck_distribution(c1, c2, T, x)*AREA_FACTORS[area_unit]