# Dimension specific Apodization methods¶

The following methods of form

(10)$y = f(a x),$

where $$a$$ is the function argument, and $$x$$ are the coordinates along the dimension, apodize the components of the dependent variables along the respective dimensions. The dimensionality of $$a$$ must be the reciprocal of that of $$x$$. The resulting CSDM object has the same number of dimensions as the original object.

Method Summary

 sin(csdm, arg[, dimension]) Apodize the components along the dimension with $$\sin(a x)$$. cos(csdm, arg[, dimension]) Apodize the components along the dimension with $$\cos(a x)$$. tan(csdm, arg[, dimension]) Apodize the components along the dimension with $$\tan(a x)$$. arcsin(csdm, arg[, dimension]) Apodize the components along the dimension with $$\arcsin(a x)$$. arccos(csdm, arg[, dimension]) Apodize the components along the dimension with $$\arccos(a x)$$. arctan(csdm, arg[, dimension]) Apodize the components along the dimension with $$\arctan(a x)$$. exp(csdm, arg[, dimension]) Apodize the components along the dimension with $$\exp(a x)$$.

Method Documentation

csdmpy.apodize.sin(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\sin(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the sine of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.cos(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\cos(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the cosine of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.tan(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\tan(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the tangent of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.arcsin(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\arcsin(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the inverse sine of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.arccos(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\arccos(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the inverse cosine of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.arctan(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\arctan(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the inverse tangent of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.

csdmpy.apodize.exp(csdm, arg, dimension=0)

Apodize the components along the dimension with $$\exp(a x)$$.

Parameters
• csdm – A CSDM object.

• arg – String or Quantity object. The function argument $$a$$.

• dimension – An integer or tuple of m integers cooresponding to the index/indices of the dimensions along which the exp of the dependent variable components is performed.

Returns

A CSDM object with d-m dimensions, where d is the total number of dimensions from the original csdm object.