cytopy.data.mapping¶

Each staining panel will have a combination of detection channel and the marker associated with that channel. This module houses ChannelMap, a simple class that keeps track of these mappings.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Classes:

ChannelMap(*args, **kwargs)

Defines channel/marker mapping.

class cytopy.data.mapping.ChannelMap(*args, **kwargs)¶

Defines channel/marker mapping. Each document will contain a single value for channel and a single value for marker, these two values are treated as a pair within the panel.

channel¶

name of channel (e.g. fluorochrome)

Type: str

marker¶

name of marker (e.g. protein)

Type: str

Methods:

`check_matched_pair`(channel, marker)	Check a channel/marker pair for resemblance
`to_dict`()	Convert object to python dictionary

check_matched_pair(channel: str, marker: str) → bool¶

Check a channel/marker pair for resemblance

Parameters

channel (str) – channel to check
marker (str) – marker to check

Returns

True if equal, else False

Return type

bool

to_dict() → dict¶

Convert object to python dictionary

Returns
Return type: dict