Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

spectrochempy.full_like

full_like(dataset, fill_value=0.0, dtype=None, **kwargs)[source]

Return a NDDataset of fill_value.

The returned NDDataset have the same shape and type as a given array. Units, coordset, … can be added in kwargs

Parameters

  • dataset (NDDataset or array-like) – Object from which to copy the array structure.

  • fill_value (scalar) – Fill value.

  • dtype (data-type, optional) – Overrides the data type of the result.

  • **kwargs – Optional keyword parameters (see Other Parameters).

Returns

fulllike – Array of fill_value with the same shape and type as dataset .

Other Parameters

  • units (str or ur instance) – Units of the returned object. If not provided, try to copy from the input object.

  • coordset (list or Coordset object) – Coordinates for the returned object. If not provided, try to copy from the input object.

See also

zeros_like

Return an array of zeros with shape and type of input.

ones_like

Return an array of ones with shape and type of input.

empty_like

Return an empty array with shape and type of input.

zeros

Return a new array setting values to zero.

ones

Return a new array setting values to one.

empty

Return a new uninitialized array.

full

Fill a new array.

Examples

3 possible ways to call this method

  1. from the API

>>> x = np.arange(6, dtype=int)
>>> scp.full_like(x, 1)
NDDataset: [float64] unitless (size: 6)

  1. as a classmethod

>>> x = np.arange(6, dtype=int)
>>> scp.NDDataset.full_like(x, 1)
NDDataset: [float64] unitless (size: 6)

  1. as an instance method

>>> scp.NDDataset(x).full_like(1, units='km')
NDDataset: [float64] km (size: 6)