Classes
MeshSource (comm, Nmesh, BoxSize, dtype) |
Base class for a source in the form of data on an input grid. |
nbodykit.base.mesh.
MeshSource
(comm, Nmesh, BoxSize, dtype)[source]¶Base class for a source in the form of data on an input grid.
The MeshSource object remembers the original source together with a sequence of transformations (added via the apply method).
dtype
is the type of the real numbers, either ‘f4’ or ‘f8’.
Parameters: |
---|
Attributes
actions |
A list of actions to apply to the density field when interpolating to the mesh. |
attrs |
A dictionary storing relevant meta-data about the CatalogSource. |
Methods
apply (func[, kind, mode]) |
Return a view of the mesh, with actions updated to |
paint ([mode, Nmesh]) |
Paint the density on the mesh and apply any transformation functions specified in actions . |
preview ([axes, Nmesh, root]) |
Gather the mesh into as a numpy array, with (reduced) resolution. |
save (output[, dataset, mode]) |
Save the mesh as a BigFileMesh on disk, either in real or complex space. |
to_complex_field ([out]) |
Convert the mesh source to the Fourier-space field, returning a pmesh.pm.ComplexField object. |
to_field ([mode, out]) |
Return the mesh as a pmesh Field object, either in Fourier space or configuration space, based on mode . |
to_real_field ([out, normalize]) |
Convert the mesh source to the configuration-space field, returning a pmesh.pm.RealField object. |
view () |
Return a “view” of the MeshSource, in the spirit of numpy’s ndarray view. |
__finalize__
(other)[source]¶Finalize the creation of a MeshSource object by copying over attributes from a second MeshSource.
Parameters: | other (MeshSource) – the second MeshSource to copy over attributes from |
---|
actions
¶A list of actions to apply to the density field when interpolating to the mesh.
This stores tuples of (mode, func, kind)
; see apply()
for more details.
apply
(func, kind='wavenumber', mode='complex')[source]¶Return a view of the mesh, with actions
updated to
apply the specified function, either in Fourier space or
configuration space, based on mode
Parameters: |
|
---|---|
Returns: | a view of the mesh object with the |
Return type: |
attrs
¶A dictionary storing relevant meta-data about the CatalogSource.
paint
(mode='real', Nmesh=None)[source]¶Paint the density on the mesh and apply
any transformation functions specified in actions
.
The return type of the pmesh
Field object is specified by
mode
. This calls to_field()
to convert the mesh to a Field.
See the documentation on painting for more details on painting catalogs to a mesh.
Parameters: | |
---|---|
Returns: | either a RealField of ComplexField, with the functions in
|
Return type: |
preview
(axes=None, Nmesh=None, root=0)[source]¶Gather the mesh into as a numpy array, with (reduced) resolution. The result is broadcast to all ranks, so this uses \(\mathrm{Nmesh}^3\) per rank.
Parameters: | |
---|---|
Returns: | out – An numpy array holding the real density field. |
Return type: | array_like |
save
(output, dataset='Field', mode='real')[source]¶Save the mesh as a BigFileMesh
on disk, either in real or complex space.
Parameters: |
---|
to_complex_field
(out=None)[source]¶Convert the mesh source to the Fourier-space field,
returning a pmesh.pm.ComplexField
object.
Not implemented in the base class, unless object is a view.
to_field
(mode='real', out=None)[source]¶Return the mesh as a pmesh
Field object, either in Fourier
space or configuration space, based on mode
.
This will call to_real_field()
or to_complex_field()
based on mode
.
Parameters: | mode ('real' or 'complex') – the return type of the field |
---|---|
Returns: | either a RealField of ComplexField, storing the value of the field on the mesh |
Return type: | RealField , ComplexField |
to_real_field
(out=None, normalize=True)[source]¶Convert the mesh source to the configuration-space field,
returning a pmesh.pm.RealField
object.
Not implemented in the base class, unless object is a view.