lsst.afw.table.schemaMapper.schemaMapperContinued.SchemaMapper Class Reference

Public Member Functions
def	addOutputField (self, field, type=None, doc=None, units="", size=None, doReplace=False, parse_strict="raise")
def	addMapping (self, input, output=None, doReplace=True)
def	__eq__ (self, other)
def	__reduce__ (self)

Detailed Description

Definition at line 33 of file schemaMapperContinued.py.

Member Function Documentation

__eq__()

def lsst.afw.table.schemaMapper.schemaMapperContinued.SchemaMapper.__eq__	(		self,
			other
	)

SchemaMappers are equal if their respective input and output
schemas are identical, and they have the same mappings defined.

Note: It was simpler to implement equality in python than in C++.

Definition at line 90 of file schemaMapperContinued.py.

    def __eq__(self, other):
        """SchemaMappers are equal if their respective input and output
        schemas are identical, and they have the same mappings defined.

        Note: It was simpler to implement equality in python than in C++.
        """
        iSchema = self.getInputSchema()
        oSchema = self.getOutputSchema()
        if (not (iSchema.compare(other.getInputSchema(), Schema.IDENTICAL) == Schema.IDENTICAL and
                 oSchema.compare(other.getOutputSchema(), Schema.IDENTICAL) == Schema.IDENTICAL)):
            return False

        for item in iSchema:
            if self.isMapped(item.key) and other.isMapped(item.key):
                if (self.getMapping(item.key) == other.getMapping(item.key)):
                    continue
                else:
                    return False
            elif (not self.isMapped(item.key)) and (not other.isMapped(item.key)):
                continue
            else:
                return False

        return True

__reduce__()

def lsst.afw.table.schemaMapper.schemaMapperContinued.SchemaMapper.__reduce__

(

self

)

To support pickle.

Definition at line 115 of file schemaMapperContinued.py.

    def __reduce__(self):
        """To support pickle."""
        mappings = {}
        for item in self.getInputSchema():
            try:
                key = self.getMapping(item.key)
            except lsst.pex.exceptions.NotFoundError:
                # Not all fields may be mapped, so just continue if a mapping is not found.
                continue
            mappings[item.key] = self.getOutputSchema().find(key).field
        return (makeSchemaMapper, (self.getInputSchema(), self.getOutputSchema(), mappings))

addMapping()

def lsst.afw.table.schemaMapper.schemaMapperContinued.SchemaMapper.addMapping	(		self,
			input,
			output = None,
			doReplace = True
	)

Add a mapped field to the output schema.

Parameters
----------
input : Key
    A Key from the input schema whose values will be mapped to the new
    field.
output : str,Field
    A Field object that describes the new field to be added to the
    output schema, or the name of the field (with documentation and
    units copied from the input schema).  May be None to copy everything
    from the input schema.
doReplace : bool
    If a field with this name already exists in the output schema,
    replace it instead of raising pex.exceptions.InvalidParameterError.

Definition at line 65 of file schemaMapperContinued.py.

    def addMapping(self, input, output=None, doReplace=True):
        """Add a mapped field to the output schema.

        Parameters
        ----------
        input : Key
            A Key from the input schema whose values will be mapped to the new
            field.
        output : str,Field
            A Field object that describes the new field to be added to the
            output schema, or the name of the field (with documentation and
            units copied from the input schema).  May be None to copy everything
            from the input schema.
        doReplace : bool
            If a field with this name already exists in the output schema,
            replace it instead of raising pex.exceptions.InvalidParameterError.
        """
        # Workaround for calling positional arguments; avoids an API change during pybind11 conversion,
        # but we should just make that change and encourage using kwargs in the
        # future.
        if output is True or output is False:
            doReplace = output
            output = None
        return input._addMappingTo(self, output, doReplace)

addOutputField()

def lsst.afw.table.schemaMapper.schemaMapperContinued.SchemaMapper.addOutputField	(		self,
			field,
			type = None,
			doc = None,
			units = "",
			size = None,
			doReplace = False,
			parse_strict = "raise"
	)

Add an un-mapped field to the output Schema.

Parameters
----------
field : str,Field
    The string name of the Field, or a fully-constructed Field object.
    If the latter, all other arguments besides doReplace are ignored.
type\n : str,type
    The type of field to create.  Valid types are the keys of the
    afw.table.Field dictionary.
doc : str
    Documentation for the field.
unit : str
    Units for the field, or an empty string if unitless.
size : int
    Size of the field; valid for string and array fields only.
doReplace : bool
    If a field with this name already exists, replace it instead of
    raising pex.exceptions.InvalidParameterError.
parse_strict : str
    One of 'raise' (default), 'warn', or 'strict', indicating how to
    handle unrecognized unit strings.  See also astropy.units.Unit.

Definition at line 36 of file schemaMapperContinued.py.

                       doReplace=False, parse_strict="raise"):
        """Add an un-mapped field to the output Schema.

        Parameters
        ----------
        field : str,Field
            The string name of the Field, or a fully-constructed Field object.
            If the latter, all other arguments besides doReplace are ignored.
        type\n : str,type
            The type of field to create.  Valid types are the keys of the
            afw.table.Field dictionary.
        doc : str
            Documentation for the field.
        unit : str
            Units for the field, or an empty string if unitless.
        size : int
            Size of the field; valid for string and array fields only.
        doReplace : bool
            If a field with this name already exists, replace it instead of
            raising pex.exceptions.InvalidParameterError.
        parse_strict : str
            One of 'raise' (default), 'warn', or 'strict', indicating how to
            handle unrecognized unit strings.  See also astropy.units.Unit.
        """
        if isinstance(field, str):
            field = Field[type](field, doc=doc, units=units,
                                size=size, parse_strict=parse_strict)
        return field._addTo(self.editOutputSchema(), doReplace)

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/python/lsst/afw/table/schemaMapper/schemaMapperContinued.py