ToFlat Class Reference

Inheritance diagram for ToFlat:

Public Member Functions
def	__init__ (self, *args)
def	get_flat_bins (self)
def	get_x (self, x_flat)

Public Attributes
	cdf
	Transformation with the CDF.

Protected Member Functions
def	_fit (self, x, y=None)
def	_transform (self, x)

Detailed Description

This transformation uses the CDF to transform input data to a
flat transformation.

Attributes
----------
cdf : Transform.CDF
    Transformation with the CDF

Definition at line 235 of file transform.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		*	args
	)

 Init function

:param args: None

Reimplemented from Transform.

Definition at line 248 of file transform.py.

    def __init__(self, *args):
        """ Init function
 
        :param args: None
        """
        Transform.__init__(self, "Flat", *args)
 
        
        self.cdf = CDF(*args)
 

Member Function Documentation

_fit()

def _fit (   self,   x,   y = None  )

protected

Fit function calculates the cumulative distribution with numpy percentile.

:param x:   Inout distribution
:param y:   Will not be used in this transformation

Reimplemented from Transform.

Definition at line 258 of file transform.py.

    def _fit(self, x, y=None):
        """
        Fit function calculates the cumulative distribution with numpy percentile.
 
        :param x:   Inout distribution
        :param y:   Will not be used in this transformation
        """
        self.io.debug("Fitting Flat")
        self.cdf.fit(x)
 

_transform()

def _transform (   self,   x  )

protected

Transforms the input data according to the cdf.
:param x:   Input data
:return:    Transformed data

Reimplemented from Transform.

Definition at line 268 of file transform.py.

    def _transform(self, x):
        """
        Transforms the input data according to the cdf.
        :param x:   Input data
        :return:    Transformed data
        """
        if not self.is_processed:
            self.fit(x)
        return self.cdf.transform(x)
 

get_flat_bins()

def get_flat_bins

(

self

)

Returns the binning of the CDF
:return: Binning for a flat distribution

Definition at line 278 of file transform.py.

    def get_flat_bins(self):
        """
        Returns the binning of the CDF
        :return: Binning for a flat distribution
        """
        return self.cdf.x
 

get_x()

def get_x	(		self,
			x_flat
	)

Dirty version for getting the original x value out of a flat x value.
:param x_flat:  x value in the flat distribution
:return:        x value on the original axis (approx)

Definition at line 285 of file transform.py.

    def get_x(self, x_flat):
        """
        Dirty version for getting the original x value out of a flat x value.
        :param x_flat:  x value in the flat distribution
        :return:        x value on the original axis (approx)
        """
        x_cumul = np.linspace(self.min, self.max, self.n_bins * 50)
        for xx in x_cumul:
            if self.cdf.spline(xx) > x_flat:
                return xx

Member Data Documentation

cdf

cdf

Transformation with the CDF.

Definition at line 256 of file transform.py.

---

The documentation for this class was generated from the following file:

• alignment/scripts/alignment/fancystuff/transform.py