PyCupid Core Wrappers

Note

For Astronomers and Advanced Users

Python Wrappers Functions to use the mean clumping algorithms in CUPID.

Clumping Functions

pycupid.pycupid.clumpfind()

ClumpFind Clumping Algorithm

Parameters:

data: numpy.array

Input data with the 2 or 3 dimensional image to analyze.

rms: float

Estimation of the RMS of noise in data. It is used to configure other parameters of the algorithm.

config: dict (default=None)

Python dictionary containing the parameters of the algorithm: config[“PARAMETER_NAME”] = PARAMETER_VALUE. If set to None, then default values of the algorithm will be used.

variance: float

Variance of the data.

velax: int

Integer value indicate which is the speed/frequency axis in the cube.

Returns:

numpy.array with integer values (numpy.int32) containing the Clump Assignment Array (CAA).

pycupid.pycupid.fellwalker()

FellWalker Clumping Algorithm

Parameters:

data: numpy.array

Input data with the 2 or 3 dimensional image to analyze.

rms: float

Estimation of the RMS of noise in data. It is used to configure other parameters of the algorithm.

config: dict (default=None)

Python dictionary containing the parameters of the algorithm: config[“PARAMETER_NAME”] = PARAMETER_VALUE. If set to None, then default values of the algorithm will be used.

variance: float

Variance of the data.

velax: int

Integer value indicate which is the speed/frequency axis in the cube.

Returns:

numpy.array with integer values (numpy.int32) containing the Clump Assignment Array (CAA).

pycupid.pycupid.gaussclumps()

GaussClump Clumping Algorithm

Parameters:

data: numpy.array

Input data with the 2 or 3 dimensional image to analyze.

rms: float

Estimation of the RMS of noise in data. It is used to configure other parameters of the algorithm.

config: dict (default=None)

Python dictionary containing the parameters of the algorithm: config[“PARAMETER_NAME”] = PARAMETER_VALUE. If set to None, then default values of the algorithm will be used.

variance: float

Variance of the data.

velax: int

Integer value indicate which is the speed/frequency axis in the cube.

Returns:

numpy.array with integer values (numpy.int32) containing the Clump Assignment Array (CAA).

pycupid.pycupid.reinhold()

Reinhold Clumping Algorithm

Parameters:

data: numpy.array

Input data with the 2 or 3 dimensional image to analyze.

rms: float

Estimation of the RMS of noise in data. It is used to configure other parameters of the algorithm.

config: dict (default=None)

Python dictionary containing the parameters of the algorithm: config[“PARAMETER_NAME”] = PARAMETER_VALUE. If set to None, then default values of the algorithm will be used.

variance: float

Variance of the data.

velax: int

Integer value indicate which is the speed/frequency axis in the cube.

Returns:

numpy.array with integer values (numpy.int32) containing the Clump Assignment Array (CAA).