Fields

The field protocol

class heracles.Field(mapper, *columns, mask=None)

Abstract base class for field definitions.

Concrete classes must implement the __call__() method which takes a catalogue instance and returns a coroutine for mapping.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)

Mathematical fields

class heracles.ComplexField(mapper, *columns, mask=None)

Field of complex values in a catalogue.

The ComplexField class has zero spin weight, while subclasses such as Spin2Field have non-zero spin weight.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)

class heracles.ScalarField(mapper, *columns, mask=None)

Field of real scalar values in a catalogue.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)

class heracles.Spin2Field(mapper, *columns, mask=None)

Spin-2 complex field.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)

Concrete fields

class heracles.Positions(mapper, *columns, overdensity=True, nbar=None, mask=None)

Field of positions in a catalogue.

Can produce both overdensity maps and number count maps, depending on the overdensity property.

Parameters:

• mapper (Mapper | None)

• columns (str)

• overdensity (bool)

• nbar (float | None)

• mask (str | None)

heracles.Shears

alias of Spin2Field

class heracles.Visibility(mapper, *columns, mask=None)

Copy visibility map from catalogue at given resolution.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)

class heracles.Weights(mapper, *columns, mask=None)

Field of weight values from a catalogue.

Parameters:

• mapper (Mapper | None)

• columns (str)

• mask (str | None)