Skip to content

Units¤

convert

dLux.utils.units.convert(value, unit_in, unit_out, scale=1.0) ¤

Convert angles from unit_in to unit_out with output unit scaling.

Returns value expressed in (scale * unit_out).

Examples:

convert(0.2, "deg", "arcsec", 1e-3) -> milliarcseconds convert(10.0, "mas", "rad") -> radians convert(1.0, "rad", "mrad") -> milliradians

Source code in dLux/utils/units.py
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def convert(value, unit_in: str, unit_out: str, scale: float = 1.0):
    """
    Convert angles from unit_in to unit_out with output unit scaling.

    Returns value expressed in (scale * unit_out).

    Examples
    --------
    convert(0.2, "deg", "arcsec", 1e-3)  -> milliarcseconds
    convert(10.0, "mas", "rad")          -> radians
    convert(1.0, "rad", "mrad")          -> milliradians
    """
    fin = unit_factor_to_rad(unit_in)
    fout = unit_factor_to_rad(unit_out)
    return value * (fin / fout) / scale
rad2arcsec

dLux.utils.units.rad2arcsec(values) ¤

Converts the inputs values from radians to arcseconds.

Parameters:

Name Type Description Default
values (Array, radians)

The input values in units of radians to be converted into arcseconds.

required

Returns:

Name Type Description
values (Array, arcseconds)

The input values converted into arcseconds.

Source code in dLux/utils/units.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def rad2arcsec(values: Array) -> Array:
    """
    Converts the inputs values from radians to arcseconds.

    Parameters
    ----------
    values : Array, radians
        The input values in units of radians to be converted into arcseconds.

    Returns
    -------
    values : Array, arcseconds
        The input values converted into arcseconds.
    """
    return convert(values, "rad", "arcsec")
rad2deg

dLux.utils.units.rad2deg(values) ¤

Converts the inputs values from radians to degrees.

Parameters:

Name Type Description Default
values (Array, radians)

The input values in units of radians to be converted into degrees.

required

Returns:

Name Type Description
values (Array, degrees)

The input values converted into degrees.

Source code in dLux/utils/units.py
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
def rad2deg(values: Array) -> Array:
    """
    Converts the inputs values from radians to degrees.

    Parameters
    ----------
    values : Array, radians
        The input values in units of radians to be converted into degrees.

    Returns
    -------
    values : Array, degrees
        The input values converted into degrees.
    """
    return convert(values, "rad", "deg")
rad2arcmin

dLux.utils.units.rad2arcmin(values) ¤

Converts the inputs values from radians to arcminutes.

Parameters:

Name Type Description Default
values (Array, radians)

The input values in units of radians to be converted into arcminutes.

required

Returns:

Name Type Description
values (Array, arcminutes)

The input values converted into arcminutes.

Source code in dLux/utils/units.py
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def rad2arcmin(values: Array) -> Array:
    """
    Converts the inputs values from radians to arcminutes.

    Parameters
    ----------
    values : Array, radians
        The input values in units of radians to be converted into arcminutes.

    Returns
    -------
    values : Array, arcminutes
        The input values converted into arcminutes.
    """
    return convert(values, "rad", "arcmin")
deg2rad

dLux.utils.units.deg2rad(values) ¤

Converts the inputs values from degrees to radians.

Parameters:

Name Type Description Default
values (Array, degrees)

The input values in units of degrees to be converted into radians.

required

Returns:

Name Type Description
values (Array, radians)

The input values converted into radians.

Source code in dLux/utils/units.py
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def deg2rad(values: Array) -> Array:
    """
    Converts the inputs values from degrees to radians.

    Parameters
    ----------
    values : Array, degrees
        The input values in units of degrees to be converted into radians.

    Returns
    -------
    values : Array, radians
        The input values converted into radians.
    """
    return convert(values, "deg", "rad")
deg2arcmin

dLux.utils.units.deg2arcmin(values) ¤

Converts the inputs values from degrees to arcminutes.

Parameters:

Name Type Description Default
values (Array, degrees)

The input values in units of degrees to be converted into arcminutes.

required

Returns:

Name Type Description
values (Array, arcminutes)

The input values converted into arcminutes.

Source code in dLux/utils/units.py
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def deg2arcmin(values: Array) -> Array:
    """
    Converts the inputs values from degrees to arcminutes.

    Parameters
    ----------
    values : Array, degrees
        The input values in units of degrees to be converted into arcminutes.

    Returns
    -------
    values : Array, arcminutes
        The input values converted into arcminutes.
    """
    return convert(values, "deg", "arcmin")
deg2arcsec

dLux.utils.units.deg2arcsec(values) ¤

Converts the inputs values from degrees to arcseconds.

Parameters:

Name Type Description Default
values (Array, degrees)

The input values in units of degrees to be converted into arcseconds.

required

Returns:

Name Type Description
values (Array, arcseconds)

The input values converted into arcseconds.

Source code in dLux/utils/units.py
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def deg2arcsec(values: Array) -> Array:
    """
    Converts the inputs values from degrees to arcseconds.

    Parameters
    ----------
    values : Array, degrees
        The input values in units of degrees to be converted into arcseconds.

    Returns
    -------
    values : Array, arcseconds
        The input values converted into arcseconds.
    """
    return convert(values, "deg", "arcsec")
arcmin2rad

dLux.utils.units.arcmin2rad(values) ¤

Converts the inputs values from arcminutes to radians.

Parameters:

Name Type Description Default
values (Array, arcminutes)

The input values in units of arcminutes to be converted into radians.

required

Returns:

Name Type Description
values (Array, radians)

The input values converted into radians.

Source code in dLux/utils/units.py
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
def arcmin2rad(values: Array) -> Array:
    """
    Converts the inputs values from arcminutes to radians.

    Parameters
    ----------
    values : Array, arcminutes
        The input values in units of arcminutes to be converted into radians.

    Returns
    -------
    values : Array, radians
        The input values converted into radians.
    """
    return convert(values, "arcmin", "rad")
arcmin2deg

dLux.utils.units.arcmin2deg(values) ¤

Converts the inputs values from arcminutes to degrees.

Parameters:

Name Type Description Default
values (Array, arcminutes)

The input values in units of arcminutes to be converted into degrees.

required

Returns:

Name Type Description
values (Array, degrees)

The input values converted into degrees.

Source code in dLux/utils/units.py
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
def arcmin2deg(values: Array) -> Array:
    """
    Converts the inputs values from arcminutes to degrees.

    Parameters
    ----------
    values : Array, arcminutes
        The input values in units of arcminutes to be converted into degrees.

    Returns
    -------
    values : Array, degrees
        The input values converted into degrees.
    """
    return convert(values, "arcmin", "deg")
arcmin2arcsec

dLux.utils.units.arcmin2arcsec(values) ¤

Converts the inputs values from arcminutes to arcseconds.

Parameters:

Name Type Description Default
values (Array, arcminutes)

The input values in units of arcminutes to be converted into arcseconds.

required

Returns:

Name Type Description
values (Array, arcseconds)

The input values converted into arcseconds.

Source code in dLux/utils/units.py
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def arcmin2arcsec(values: Array) -> Array:
    """
    Converts the inputs values from arcminutes to arcseconds.

    Parameters
    ----------
    values : Array, arcminutes
        The input values in units of arcminutes to be converted into
        arcseconds.

    Returns
    -------
    values : Array, arcseconds
        The input values converted into arcseconds.
    """
    return convert(values, "arcmin", "arcsec")
arcsec2rad

dLux.utils.units.arcsec2rad(values) ¤

Converts the inputs values from arcseconds to radians.

Parameters:

Name Type Description Default
values (Array, arcseconds)

The input values in units of arcseconds to be converted into radians.

required

Returns:

Name Type Description
values (Array, radians)

The input values converted into radians.

Source code in dLux/utils/units.py
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def arcsec2rad(values: Array) -> Array:
    """
    Converts the inputs values from arcseconds to radians.

    Parameters
    ----------
    values : Array, arcseconds
        The input values in units of arcseconds to be converted into radians.

    Returns
    -------
    values : Array, radians
        The input values converted into radians.
    """
    return convert(values, "arcsec", "rad")
arcsec2deg

dLux.utils.units.arcsec2deg(values) ¤

Converts the inputs values from arcseconds to degrees.

Parameters:

Name Type Description Default
values (Array, arcseconds)

The input values in units of arcseconds to be converted into degrees.

required

Returns:

Name Type Description
values (Array, degrees)

The input values converted into degrees.

Source code in dLux/utils/units.py
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
def arcsec2deg(values: Array) -> Array:
    """
    Converts the inputs values from arcseconds to degrees.

    Parameters
    ----------
    values : Array, arcseconds
        The input values in units of arcseconds to be converted into degrees.

    Returns
    -------
    values : Array, degrees
        The input values converted into degrees.
    """
    return convert(values, "arcsec", "deg")
arcsec2arcmin

dLux.utils.units.arcsec2arcmin(values) ¤

Converts the inputs values from arcseconds to arcminutes.

Parameters:

Name Type Description Default
values (Array, arcseconds)

The input values in units of arcseconds to be converted into arcminutes.

required

Returns:

Name Type Description
values (Array, arcminutes)

The input values converted into arcminutes.

Source code in dLux/utils/units.py
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def arcsec2arcmin(values: Array) -> Array:
    """
    Converts the inputs values from arcseconds to arcminutes.

    Parameters
    ----------
    values : Array, arcseconds
        The input values in units of arcseconds to be converted into
        arcminutes.

    Returns
    -------
    values : Array, arcminutes
        The input values converted into arcminutes.
    """
    return convert(values, "arcsec", "arcmin")