ComputeTGLR

class muse_origin.ComputeTGLR(orig, idx, param)

Bases: muse_origin.Step

Compute the cube of GLR test values.

The test is done on the cube containing the faint signal (self.cube_faint) and it uses the PSF and the spectral profiles. Then compute the p-values of local maximum of correlation values.

Parameters

sizeint

Connectivity of contiguous voxels per axis for the maximum filter.

ncpuint

Number of CPUs used, defaults to 1.

pcutfloat

Cut applied to the profiles to limit their width (defaults to 1e-8).

pmeansubbool

Subtract the mean of the profiles (defaults to True).

Returns

self.cube_correlCube

Cube of T_GLR values.

self.correl_minCube

Cube of T_GLR values of minimum correlation.

self.cube_profileCube (type int)

Number of the profile associated to the T_GLR.

self.maxmapImage

Map of maximum correlations along the wavelength axis.

self.minmapImage

Map of minimum correlations along the wavelength axis.

self.cube_local_maxCube

Local maxima from max correlation.

self.cube_local_minCube

Local maxima from minus min correlation.

Attributes Summary

cube_correl
cube_correl_min
cube_local_max
cube_local_min
cube_profile
desc
maxmap
minmap
name
require
status	Processing status (muse_origin.Status):

Methods Summary

__call__(self, \*args, \*\*kwargs)	Run a step, calling its run method.
dump(self, outpath)	Save the attributes that have been created by the steps, and unload them to free memory.
load(self, outpath)	Recreate attributes of a step, not really loading them as just the file is set, and files are loaded in memory only if needed.
run(self, orig[, size, ncpu, pcut, pmeansub])
store_cube(self, name, data, \*\*kwargs)	Create a MPDAF Cube and store it as an attribute.
store_image(self, name, data, \*\*kwargs)	Create a MPDAF Image and store it as an attribute.

Attributes Documentation

cube_correl = None

cube_correl_min = None

cube_local_max = None

cube_local_min = None

cube_profile = None

desc = 'GLR test'

maxmap = None

minmap = None

name = 'compute_TGLR'

require = ('compute_greedy_PCA',)

status

Processing status (muse_origin.Status):

• NOTRUN: The step has not been run.

• RUN: The step has been run but not saved.

• DUMP: The step has been run and its outputs saved to disk.

• FAILED: The step has been run but it failed.

Methods Documentation

__call__(self, *args, **kwargs)

Run a step, calling its run method.

This method is the one that is called from the ORIGIN object. It calls the run method of the step and also does a few additional things like storing the parameters, execution time and date.

dump(self, outpath)

Save the attributes that have been created by the steps, and unload them to free memory.

load(self, outpath)

Recreate attributes of a step, not really loading them as just the file is set, and files are loaded in memory only if needed.

run(self, orig, size=3, ncpu=1, pcut=1e-08, pmeansub=True)

store_cube(self, name, data, **kwargs)

Create a MPDAF Cube and store it as an attribute.

store_image(self, name, data, **kwargs)

Create a MPDAF Image and store it as an attribute.