selectionfunctions modules¶
cog_ii (Boubert & Everall, 2020, submitted)¶
-
class
selectionfunctions.cog_ii.
dr2_sf
(map_fname=None, version='modelAB', crowding=False, bounds=True)[source]¶ Bases:
selectionfunctions.map.SelectionFunction
Queries the Gaia DR2 selection function (Boubert & Everall, 2019).
-
__init__
(map_fname=None, version='modelAB', crowding=False, bounds=True)[source]¶ Parameters: - map_fname (Optional[
str
]) – Filename of the BoubertEverall2019 selection function. Defaults toNone
, meaning that the default location is used. - version (Optional[
str
]) – The selection function version to download. Valid versions are'modelT'
and'modelAB'
Defaults to'modelT'
. - crowding (Optional[
bool
]) – Whether or not the selection function includes crowding. Defaults to'False'
. - bounds (Optional[
bool
]) – Whether or not the selection function is bounded to 0.0 < G < 25.0. Defaults to'True'
.
- map_fname (Optional[
-
-
class
selectionfunctions.cog_ii.
dr3_sf
(map_fname_dr3=None, map_fname_dr2=None, version='modelAB', crowding=False, bounds=True)[source]¶ Bases:
selectionfunctions.cog_ii.dr2_sf
-
__init__
(map_fname_dr3=None, map_fname_dr2=None, version='modelAB', crowding=False, bounds=True)[source]¶ Args: map_fname (Optional[
str
]): Filename of the BoubertEverall2019 selection function. Defaults toNone
, meaning that the default location is used.- version (Optional[
str
]): The selection function version to download. Valid versions - are
'modelT'
and'modelAB'
Defaults to'modelT'
. - crowding (Optional[
bool
]): Whether or not the selection function includes crowding. - Defaults to
'False'
. - bounds (Optional[
bool
]): Whether or not the selection function is bounded to 0.0 < G < 25.0. - Defaults to
'True'
.
- version (Optional[
-
-
selectionfunctions.cog_ii.
fetch
()[source]¶ Downloads the specified version of the Bayestar dust map.
Parameters: version (Optional[
str
]) – The map version to download. Valid versions are'bayestar2019'
(Green, Schlafly, Finkbeiner et al. 2019),'bayestar2017'
(Green, Schlafly, Finkbeiner et al. 2018) and'bayestar2015'
(Green, Schlafly, Finkbeiner et al. 2015). Defaults to'bayestar2019'
.Raises: - ValueError – The requested version of the map does not exist.
- DownloadError – Either no matching file was found under the given DOI, or the MD5 sum of the file was not as expected.
- requests.exceptions.HTTPError – The given DOI does not exist, or there was a problem connecting to the Dataverse.
fetch_utils¶
-
exception
selectionfunctions.fetch_utils.
DownloadError
[source]¶ Bases:
selectionfunctions.fetch_utils.Error
An exception that occurs while trying to download a file.
-
exception
selectionfunctions.fetch_utils.
Error
[source]¶ Bases:
Exception
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
selectionfunctions.fetch_utils.
FileTransferProgressBar
(content_length)[source]¶ Bases:
progressbar.bar.ProgressBar
-
selectionfunctions.fetch_utils.
check_md5sum
(fname, md5sum, chunk_size=1024)[source]¶ Checks that a file exists, and has the correct MD5 checksum.
Parameters: - fname (str) – The filename of the file.
- md5sum (str) – The expected MD5 sum.
- chunk_size (Optional[int]) – Process in chunks of this size (in Bytes). Defaults to 1024.
-
selectionfunctions.fetch_utils.
dataverse_download_doi
(doi, local_fname=None, file_requirements={}, original=False, clobber=False)[source]¶ Downloads a file from the Dataverse, using a DOI and set of metadata parameters to locate the file.
Parameters: - doi (str) – Digital Object Identifier (DOI) containing the file.
- local_fname (Optional[str]) – Local filename to download the file to. If None, then use the filename provided by the Dataverse. Defaults to None.
- file_requirements (Optional[dict]) – Select the file containing the given metadata entries. If multiple files meet these requirements, only the first in downloaded. Defaults to {}, corresponding to no requirements.
- original (Optional[bool]) – Should the original version of the file be downloaded? Only applicable for tabular data. Defaults to False.
Raises: - DownloadError – Either no matching file was found under the given DOI, or the MD5 sum of the file was not as expected.
- requests.exceptions.HTTPError – The given DOI does not exist, or there was a problem connecting to the Dataverse.
-
selectionfunctions.fetch_utils.
dataverse_search_doi
(doi)[source]¶ Fetches metadata pertaining to a Digital Object Identifier (DOI) in the Harvard Dataverse.
Parameters: doi (str) – The Digital Object Identifier (DOI) of the entry in the Dataverse. Raises: requests.exceptions.HTTPError – The given DOI does not exist, or there was a problem connecting to the Dataverse.
-
selectionfunctions.fetch_utils.
download
(url, fname=None)[source]¶ Downloads a file.
Parameters: - url (str) – The URL to download.
- fname (Optional[str]) – The filename to store the downloaded file in. If None, take the filename from the URL. Defaults to None.
Returns: The filename the URL was downloaded to.
Raises: requests.exceptions.HTTPError – There was a problem connecting to the URL.
-
selectionfunctions.fetch_utils.
download_and_verify
(url, md5sum, fname=None, chunk_size=1024, clobber=False, verbose=True)[source]¶ Downloads a file and verifies the MD5 sum.
Parameters: - url (str) – The URL to download.
- md5sum (str) – The expected MD5 sum.
- fname (Optional[str]) – The filename to store the downloaded file in. If None, infer the filename from the URL. Defaults to None.
- chunk_size (Optional[int]) – Process in chunks of this size (in Bytes). Defaults to 1024.
- clobber (Optional[bool]) – If True, any existing, identical file will be overwritten. If False, the MD5 sum of any existing file with the destination filename will be checked. If the MD5 sum does not match, the existing file will be overwritten. Defaults to False.
- verbose (Optional[bool]) – If True (the default), then a progress bar will be shownd during downloads.
Returns: The filename the URL was downloaded to.
Raises: - DownloadError – The MD5 sum of the downloaded file does not match md5sum.
- requests.exceptions.HTTPError – There was a problem connecting to the URL.
-
selectionfunctions.fetch_utils.
get_md5sum
(fname, chunk_size=1024)[source]¶ Returns the MD5 checksum of a file.
Parameters: - fname (str) – Filename
- chunk_size (Optional[int]) – Size (in Bytes) of the chunks that should be read in at once. Increasing chunk size reduces the number of reads required, but increases the memory usage. Defaults to 1024.
Returns: The MD5 checksum of the file, which is a string.
-
selectionfunctions.fetch_utils.
h5_file_exists
(fname, size_guess=None, rtol=0.1, atol=1.0, dsets={})[source]¶ Returns
True
if an HDF5 file exists, has the expected file size, and contains (at least) the given datasets, with the correct shapes.Parameters: - fname (str) – Filename to check.
- size_guess (Optional[int]) – Expected size (in Bytes) of the file. If
None
(the default), then filesize is not checked. - rtol (Optional[float]) – Relative tolerance for filesize.
- atol (Optional[float]) – Absolute tolerance (in Bytes) for filesize.
- dsets (Optional[dict]) – Dictionary specifying expected datasets. Each
key is the name of a dataset, while each value is the expected shape
of the dataset. Defaults to
{}
, meaning that no datasets are checked.
Returns: True
if the file matches by all given criteria.
map¶
-
class
selectionfunctions.map.
SelectionFunction
[source]¶ Bases:
object
Base class for querying selectionfunctions. For each individual selection function, a different subclass should be written, implementing the
query()
function.-
__call__
(coords, **kwargs)[source]¶ An alias for
SelectionFunction.query
.
-
query
(coords, **kwargs)[source]¶ Query the selection function at a set of coordinates.
Parameters: coords ( astropy.coordinates.SkyCoord
) – The coordinates at which to query the selection function.Raises: NotImplementedError – This function must be defined by derived classes.
-
query_equ
(ra, dec, d=None, frame='icrs', **kwargs)[source]¶ Query using Equatorial coordinates. By default, the ICRS frame is used, although other frames implemented by
astropy.coordinates
may also be specified.Parameters: - ra (
float
, scalar or array-like) – Galactic longitude, in degrees, or as anastropy.unit.Quantity
. - dec (float, scalar or array-like) – Galactic latitude, in degrees,
or as an
astropy.unit.Quantity
. - d (Optional[
float
, scalar or array-like]) – Distance from the Solar System, in kpc, or as anastropy.unit.Quantity
. Defaults toNone
, meaning no distance is specified. - frame (Optional[
icrs
]) – The coordinate system. Can be'icrs'
(the default),'fk5'
,'fk4'
or'fk4noeterms'
. - **kwargs – Any additional keyword arguments accepted by derived classes.
Returns: The results of the query, which must be implemented by derived classes.
- ra (
-
query_gal
(l, b, d=None, **kwargs)[source]¶ Query using Galactic coordinates.
Parameters: - l (
float
, scalar or array-like) – Galactic longitude, in degrees, or as anastropy.unit.Quantity
. - b (
float
, scalar or array-like) – Galactic latitude, in degrees, or as anastropy.unit.Quantity
. - d (Optional[
float
, scalar or array-like]) – Distance from the Solar System, in kpc, or as anastropy.unit.Quantity
. Defaults toNone
, meaning no distance is specified. - **kwargs – Any additional keyword arguments accepted by derived classes.
Returns: The results of the query, which must be implemented by derived classes.
- l (
-
-
class
selectionfunctions.map.
WebSelectionFunction
(api_url=None, map_name='')[source]¶ Bases:
object
Base class for querying selection functions through a web API. For each individual selection functions, a different subclass should be written, specifying the base URL.
-
query
(coords, **kwargs)[source]¶ A web API version of
SelectionFunction.query
. See the documentation for the corresponding local query object.Parameters: coords ( astropy.coordinates.SkyCoord
) – The coordinates at which to query the selection function.
-
query_equ
(ra, dec, d=None, frame='icrs', **kwargs)[source]¶ A web API version of
SelectionFunction.query_equ()
. See the documentation for the corresponding local query object. Queries using Equatorial coordinates. By default, the ICRS frame is used, although other frames implemented byastropy.coordinates
may also be specified.Parameters: - ra (
float
, scalar or array-like) – Galactic longitude, in degrees, or as anastropy.unit.Quantity
. - dec (
float
, scalar or array-like) – Galactic latitude, in degrees, or as anastropy.unit.Quantity
. - d (Optional[
float
, scalar or array-like]) – Distance from the Solar System, in kpc, or as anastropy.unit.Quantity
. Defaults toNone
, meaning no distance is specified. - frame (Optional[icrs]) – The coordinate system. Can be ‘icrs’ (the default), ‘fk5’, ‘fk4’ or ‘fk4noeterms’.
- **kwargs – Any additional keyword arguments accepted by derived classes.
Returns: The results of the query.
- ra (
-
query_gal
(l, b, d=None, **kwargs)[source]¶ A web API version of
SelectionFunction.query_gal()
. See the documentation for the corresponding local query object. Queries using Galactic coordinates.Parameters: - l (
float
, scalar or array-like) – Galactic longitude, in degrees, or as anastropy.unit.Quantity
. - b (
float
, scalar or array-like) – Galactic latitude, in degrees, or as anastropy.unit.Quantity
. - d (Optional[
float
, scalar or array-like]) – Distance from the Solar System, in kpc, or as anastropy.unit.Quantity
. Defaults toNone
, meaning no distance is specified. - **kwargs – Any additional keyword arguments accepted by derived classes.
Returns: The results of the query.
- l (
-
-
selectionfunctions.map.
coord2healpix
(coords, frame, nside, nest=True)[source]¶ Calculate HEALPix indices from an astropy SkyCoord. Assume the HEALPix system is defined on the coordinate frame
frame
.Parameters: - coords (
astropy.coordinates.SkyCoord
) – The input coordinates. - frame (
str
) – The frame in which the HEALPix system is defined. - nside (
int
) – The HEALPix nside parameter to use. Must be a power of 2. - nest (Optional[
bool
]) –True
(the default) if nested HEALPix ordering is desired.False
for ring ordering.
Returns: An array of pixel indices (integers), with the same shape as the input SkyCoord coordinates (
coords.shape
).Raises: sfexceptions.CoordFrameError – If the specified frame is not supported.
- coords (
-
selectionfunctions.map.
ensure_coord_type
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator raises a
TypeError
if thecoords
that gets passed toClass.method
is not anastropy.coordinates.SkyCoord
instance.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that raises a TypeError
ifcoords
is not anastropy.coordinates.SkyCoord
object, but which otherwise behaves the same as the decorated function.
-
selectionfunctions.map.
ensure_flat_coords
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
-
selectionfunctions.map.
ensure_flat_galactic
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Galactic coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
-
selectionfunctions.map.
ensure_flat_icrs
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Equatorial coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
source¶
-
selectionfunctions.source.
ensure_distance
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Equatorial coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
-
selectionfunctions.source.
ensure_gaia_g
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Equatorial coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
-
selectionfunctions.source.
ensure_gaia_g_gaia_rp
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Equatorial coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
-
selectionfunctions.source.
ensure_tmass_hjk
(f)[source]¶ A decorator for class methods of the form
Class.method(self, coords, **kwargs)
where
coords
is anastropy.coordinates.SkyCoord
object.The decorator ensures that the
coords
that gets passed toClass.method
is a flat array of Equatorial coordinates. It also reshapes the output ofClass.method
to have the same shape (possibly scalar) as the inputcoords
. If the output ofClass.method
is a tuple or list (instead of an array), each element in the output is reshaped instead.Parameters: f (class method) – A function with the signature (self, coords, **kwargs)
, wherecoords
is aSkyCoord
object containing an array.Returns: A function that takes SkyCoord
input with any shape (including scalar).
healpix_map¶
-
class
selectionfunctions.healpix_map.
HEALPixFITSQuery
(fname, coord_frame, hdu=0, field=None, dtype='f8')[source]¶ Bases:
selectionfunctions.healpix_map.HEALPixQuery
A HEALPix map class that is initialized from a FITS file.
-
__init__
(fname, coord_frame, hdu=0, field=None, dtype='f8')[source]¶ Parameters: - fname (str, HDUList, TableHDU or BinTableHDU) – The filename, HDUList or HDU from which the map should be loaded.
- coord_frame (str) – The coordinate system in which the HEALPix map is
defined. Must be a coordinate frame which
astropy
understands. - hdu (Optional[int or str]) – Specifies which HDU to load the map
from. Defaults to
0
. - field (Optional[int or str]) – Specifies which field (column) to load
the map from. Defaults to
None
, meaning thathdu.data[:]
is used. - dtype (Optional[str or type]) – The data will be coerced to this
datatype. Can be any type specification that numpy understands.
Defaults to
'f8'
, for IEEE754 double precision.
-
-
class
selectionfunctions.healpix_map.
HEALPixQuery
(pix_val, nest, coord_frame)[source]¶ Bases:
selectionfunctions.map.SelectionFunction
A class for querying HEALPix maps.
-
__init__
(pix_val, nest, coord_frame)[source]¶ Parameters: - pix_val (array) – Value of the map in every pixel. The length of the array must be of the form 12 * nside**2, where nside is a power of two.
- nest (bool) – True if the map uses nested ordering. False if ring ordering is used.
- coord_frame (str) – The coordinate system that the HEALPix map is in. Should be one of the frames supported by astropy.coordinates.
-
unstructured_map¶
config¶
-
class
selectionfunctions.config.
Configuration
(fname)[source]¶ Bases:
object
A class that stores the package configuration.
-
get
(key, default=None)[source]¶ Gets a configuration option, returning a default value if the specified key isn’t set.
-
save
(force=False)[source]¶ Saves the configuration to a JSON, in the standard config location.
Parameters: force (Optional[ bool
]) – Continue writing, even if the original config file was not loaded properly. This is dangerous, because it could cause the previous configuration options to be lost. Defaults toFalse
.Raises: ConfigError – if the configuration file was not successfully loaded on initialization of the class, and force
isFalse
.
-
-
selectionfunctions.config.
config
= <selectionfunctions.config.Configuration object>¶ The package configuration. This is the object that the user should interact with in order to change settings. For example, to set the directory where large files (e.g., selections functions) will be stored:
from selectionfunctions.config import config config['data_dir'] = '/path/to/data/directory'
std_paths¶
-
selectionfunctions.std_paths.
data_dir
()[source]¶ Returns the directory used to store large data files (e.g., dust maps).
json_serializers¶
-
class
selectionfunctions.json_serializers.
MultiJSONDecoder
(*args, **kwargs)[source]¶ Bases:
json.decoder.JSONDecoder
- A JSON decoder that can handle:
numpy.ndarray
numpy.dtype
astropy.units.Quantity
astropy.coordinates.SkyCoord
-
__init__
(*args, **kwargs)[source]¶ object_hook
, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the givendict
. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).object_pairs_hook
, if specified will be called with the result of every JSON object decoded with an ordered list of pairs. The return value ofobject_pairs_hook
will be used instead of thedict
. This feature can be used to implement custom decoders. Ifobject_hook
is also defined, theobject_pairs_hook
takes priority.parse_float
, if specified, will be called with the string of every JSON float to be decoded. By default this is equivalent to float(num_str). This can be used to use another datatype or parser for JSON floats (e.g. decimal.Decimal).parse_int
, if specified, will be called with the string of every JSON int to be decoded. By default this is equivalent to int(num_str). This can be used to use another datatype or parser for JSON integers (e.g. float).parse_constant
, if specified, will be called with one of the following strings: -Infinity, Infinity, NaN. This can be used to raise an exception if invalid JSON numbers are encountered.If
strict
is false (true is the default), then control characters will be allowed inside strings. Control characters in this context are those with character codes in the 0-31 range, including'\t'
(tab),'\n'
,'\r'
and'\0'
.
-
selectionfunctions.json_serializers.
deserialize_dtype
(d)[source]¶ Deserializes a JSONified
numpy.dtype
.Parameters: d ( dict
) – A dictionary representation of adtype
object.Returns: A dtype
object.
-
selectionfunctions.json_serializers.
deserialize_ndarray
(d)[source]¶ Deserializes a JSONified
numpy.ndarray
. Can handle arrays serialized using any of the methods in this module:"npy"
,"b64"
,"readable"
.Parameters: d (dict) – A dictionary representation of an ndarray
object.Returns: An ndarray
object.
-
selectionfunctions.json_serializers.
deserialize_ndarray_npy
(d)[source]¶ Deserializes a JSONified
numpy.ndarray
that was created using numpy’ssave
function.Parameters: d ( dict
) – A dictionary representation of anndarray
object, created usingnumpy.save
.Returns: An ndarray
object.
-
selectionfunctions.json_serializers.
deserialize_quantity
(d)[source]¶ Deserializes a JSONified
astropy.units.Quantity
.Parameters: d ( dict
) – A dictionary representation of aQuantity
object.Returns: A Quantity
object.
-
selectionfunctions.json_serializers.
deserialize_skycoord
(d)[source]¶ Deserializes a JSONified
astropy.coordinates.SkyCoord
.Parameters: d ( dict
) – A dictionary representation of aSkyCoord
object.Returns: A SkyCoord
object.
-
selectionfunctions.json_serializers.
deserialize_tuple
(d)[source]¶ Deserializes a JSONified tuple.
Parameters: d ( dict
) – A dictionary representation of the tuple.Returns: A tuple.
-
selectionfunctions.json_serializers.
get_encoder
(ndarray_mode='b64')[source]¶ - Returns a JSON encoder that can handle:
numpy.ndarray
numpy.floating
(converted tofloat
)numpy.integer
(converted toint
)numpy.dtype
astropy.units.Quantity
astropy.coordinates.SkyCoord
Parameters: ndarray_mode (Optional[ str
]) – Which method to use to serializenumpy.ndarray
objects. Defaults to'b64'
, which converts the array data to binary64 encoding (non-human-readable), and stores the datatype/shape in human-readable formats. Other options are'readable'
, which produces fully human-readable output, and'npy'
, which uses numpy’s built-insave
function and produces completely unreadable output. Of all the methods'npy'
is the most reliable, but also least human-readable.'readable'
produces the most human-readable output, but is the least reliable and loses precision.Returns: A subclass of json.JSONEncoder
.
-
selectionfunctions.json_serializers.
hint_tuples
(o)[source]¶ Annotates tuples before JSON serialization, so that they can be reconstructed during deserialization. Each tuple is converted into a dictionary of the form:
{‘_type’: ‘tuple’, ‘items’: (…)}This function acts recursively on lists, so that tuples nested inside a list (or doubly nested, triply nested, etc.) will also be annotated.
-
selectionfunctions.json_serializers.
serialize_dtype
(o)[source]¶ Serializes a
numpy.dtype
.Parameters: o ( numpy.dtype
) –dtype
to be serialized.Returns: A dictionary that can be passed to json.dumps
.
-
selectionfunctions.json_serializers.
serialize_ndarray_b64
(o)[source]¶ Serializes a
numpy.ndarray
in a format where the datatype and shape are human-readable, but the array data itself is binary64 encoded.Parameters: o ( numpy.ndarray
) –ndarray
to be serialized.Returns: A dictionary that can be passed to json.dumps
.
-
selectionfunctions.json_serializers.
serialize_ndarray_npy
(o)[source]¶ Serializes a
numpy.ndarray
using numpy’s built-insave
function. This produces totally unreadable (and very un-JSON-like) results (in “npy” format), but it’s basically guaranteed to work in 100% of cases.Parameters: o ( numpy.ndarray
) –ndarray
to be serialized.Returns: A dictionary that can be passed to json.dumps
.
-
selectionfunctions.json_serializers.
serialize_ndarray_readable
(o)[source]¶ Serializes a
numpy.ndarray
in a human-readable format.Parameters: o ( numpy.ndarray
) –ndarray
to be serialized.Returns: A dictionary that can be passed to json.dumps
.