Data Utils (utilipy.data_utils)

Reference/API

utilipy.data_utils Package

Data Utilities.

Functions

idxDecorator([function, as_ind, _doc_fmt, …])

Control whether to return boolean array or indices.

indices_xmatch_fields(catalog, *others, fields)

Indices of xmatch of catalogs’ data field(s) against a source catalog.

xmatch_fields(catalog, *others, fields)

Cross-match catalogs’ data field(s) against a source catalog.

xmatch(*catalogs, match_fields)

Cross-match two catalogs.

non_xmatched(catalog1, catalog2, indices1, …)

Find non cross-matched catalog components.

make_shuffler(length[, rng])

Shuffle and Unshuffle arrays.

get_path_to_file(*data_name[, package])

Get path to file.

inRange(*args[, rng, lbi, ubi, as_ind])

Multidimensional box selection.

outRange(*args[, rng, lbi, ubi, as_ind])

Multidimensional box exclusion.

ioRange([incl, excl, rng, as_ind])

Supports inRange and outRange.

ellipse(*x[, x0, dx, as_ind])

Elliptical selection of data in many dimensions.

circle(*x[, x0, radius, as_ind])

Circular selection of data in many dimensions.

Classes

TransformGraph(seed_basic)

Graph representing the paths between data types.

DataTransform(func, fromtype, totype, priority)

A transformation defined by a function.

Class Inheritance Diagram

Inheritance diagram of utilipy.data_utils.xfm.graph.TransformGraph, utilipy.data_utils.xfm.transformations.DataTransform

utilipy.data_utils.decorators Module

data_util decorators.

Functions

idxDecorator([function, as_ind, _doc_fmt, …])

Control whether to return boolean array or indices.

utilipy.data_utils.select Module

Selection Functions.

Examples

do some examples here

Functions

inRange(*args[, rng, lbi, ubi, as_ind])

Multidimensional box selection.

outRange(*args[, rng, lbi, ubi, as_ind])

Multidimensional box exclusion.

ioRange([incl, excl, rng, as_ind])

Supports inRange and outRange.

ellipse(*x[, x0, dx, as_ind])

Elliptical selection of data in many dimensions.

circle(*x[, x0, radius, as_ind])

Circular selection of data in many dimensions.

utilipy.data_utils.crossmatch Module

Catalog x-matching on data fields.

Built from the extensive x-matching program in Jo Bovy’s gaia_tools, but reconfigured to use the Astropy framework as much as possible.

Functions

indices_xmatch_fields(catalog, *others, fields)

Indices of xmatch of catalogs’ data field(s) against a source catalog.

xmatch_fields(catalog, *others, fields)

Cross-match catalogs’ data field(s) against a source catalog.

xmatch(*catalogs, match_fields)

Cross-match two catalogs.

non_xmatched(catalog1, catalog2, indices1, …)

Find non cross-matched catalog components.