- class FilterDetectionsStage(c, threshold=0.5, copy=True, filter_source=<FilterSource.Auto: 0>, field_name='probs')[source]
Bases:
morpheus.pipeline.single_port_stage.SinglePortStage
Filter message by a classification threshold.
The FilterDetectionsStage is used to filter rows from a dataframe based on values in a tensor using a specified criteria. Rows in the
meta
dataframe are excluded if their associated value in theprobs
array is less than or equal tothreshold
.This stage can operate in two different modes set by the
copy
argument. When thecopy
argument isTrue
(default), rows that meet the filter criteria are copied into a new dataframe. WhenFalse
sliced views are used instead.Setting
copy=True
should be used when the number of matching records is expected to be both high and in non-adjacent rows. In this mode, the stage will generate only one output message for each incoming message, regardless of the size of the input and the number of matching records. However this comes at the cost of needing to allocate additional memory and perform the copy. Note: In most other stages, messages emitted contain a reference to the originalMessageMeta
emitted into the pipeline by the source stage. When using copy mode this won’t be the case and could cause the originalMessageMeta
to be deallocated after this stage.Setting
copy=False
should be used when either the number of matching records is expected to be very low or are likely to be contained in adjacent rows. In this mode, slices of contiguous blocks of rows are emitted in multiple output messages. Performing a slice is relatively low-cost, however for each incoming message the number of emitted messages could be high (in the worst case scenario as high as half the number of records in the incoming message). Depending on the downstream stages, this can cause performance issues, especially if those stages need to acquire the Python GIL.- Parameters
-
c :
morpheus.config.Config
- threshold
- copy
-
filter_source :
morpheus.common.FilterSource
- field_name
Pipeline configuration instance.
Threshold to classify, default is 0.5.
Whether or not to perform a copy.
Indicate if we are operating on is an output tensor or a field in the DataFrame. Choosing
Auto
will default toTENSOR
when the incoming message contains output tensorts andDATAFRAME
otherwise.Name of the tensor or DataFrame column to use as the filter criteria
-
c :
- Attributes
has_multi_input_ports
has_multi_output_ports
input_ports
is_built
is_pre_built
name
output_ports
unique_name
Indicates if this stage has multiple input ports.
Indicates if this stage has multiple output ports.
Input ports to this stage.
Indicates if this stage has been built.
Indicates if this stage has been built.
The name of the stage.
Output ports from this stage.
Unique name of stage.
Methods
accepted_types
()Accepted input types for this stage are returned. build
(builder[, do_propagate])Build this stage. can_build
([check_ports])Determines if all inputs have been built allowing this node to be built. can_pre_build
([check_ports])Determines if all inputs have been built allowing this node to be built. compute_schema
(schema)Compute the schema for this stage based on the incoming schema from upstream stages. get_all_input_stages
()Get all input stages to this stage. get_all_inputs
()Get all input senders to this stage. get_all_output_stages
()Get all output stages from this stage. get_all_outputs
()Get all output receivers from this stage. get_needed_columns
()Stages which need to have columns inserted into the dataframe, should populate the self._needed_columns
dictionary with mapping of column names tomorpheus.common.TypeId
.join
()Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped. start_async
()This function is called along with on_start during stage initialization. stop
()Stages can implement this to perform cleanup steps when pipeline is stopped. supports_cpp_node
()Specifies whether this Stage is capable of creating C++ nodes. - _build(builder, input_nodes)[source]
This function is responsible for constructing this stage’s internal
mrc.SegmentObject
object. The input of this function contains the returned value from the upstream stage.The input values are the
mrc.Builder
for this stage and a list of parent nodes.- Parameters
-
builder :
mrc.Builder
-
input_nodes :
list[mrc.SegmentObject]
mrc.Builder
object for the pipeline. This should be used to construct/attach the internalmrc.SegmentObject
.List containing the input
mrc.SegmentObject
objects.-
builder :
- Returns
list[mrc.SegmentObject]
List of tuples containing the output
mrc.SegmentObject
object from this stage.
- accepted_types()[source]
Accepted input types for this stage are returned.
- Returns
- typing.Tuple[
morpheus.pipeline.messages.MultiMessage
, ]
Accepted input types.
- typing.Tuple[
- build(builder, do_propagate=True)[source]
Build this stage.
- Parameters
-
builder :
mrc.Builder
- do_propagate
MRC segment for this stage.
Whether to propagate to build output stages, by default True.
-
builder :
- can_build(check_ports=False)[source]
Determines if all inputs have been built allowing this node to be built.
- Parameters
- check_ports
Check if we can build based on the input ports, by default False.
- Returns
- bool
True if we can build, False otherwise.
- can_pre_build(check_ports=False)[source]
Determines if all inputs have been built allowing this node to be built.
- Parameters
- check_ports
Check if we can build based on the input ports, by default False.
- Returns
- bool
True if we can build, False otherwise.
- compute_schema(schema)[source]
Compute the schema for this stage based on the incoming schema from upstream stages.
Incoming schema and type information from upstream stages is available via the
schema.input_schemas
andschema.input_types
properties.Derived classes need to override this method, can set the output type(s) on
schema
by callingset_type
for all output ports. For example a simple pass-thru stage might perform the following:If the port types in
upstream_schema
are incompatible the stage should raise aRuntimeError
.- get_all_input_stages()[source]
Get all input stages to this stage.
- Returns
- list[
morpheus.pipeline.pipeline.StageBase
]
All input stages.
- list[
- get_all_inputs()[source]
Get all input senders to this stage.
- Returns
- list[
morpheus.pipeline.pipeline.Sender
]
All input senders.
- list[
- get_all_output_stages()[source]
Get all output stages from this stage.
- Returns
- list[
morpheus.pipeline.pipeline.StageBase
]
All output stages.
- list[
- get_all_outputs()[source]
Get all output receivers from this stage.
- Returns
- list[
morpheus.pipeline.pipeline.Receiver
]
All output receivers.
- list[
- get_needed_columns()[source]
Stages which need to have columns inserted into the dataframe, should populate the
self._needed_columns
dictionary with mapping of column names tomorpheus.common.TypeId
. This will ensure that the columns are allocated and populated with null values.- property has_multi_input_ports: bool
Indicates if this stage has multiple input ports.
- Returns
- bool
True if stage has multiple input ports, False otherwise.
- property has_multi_output_ports: bool
Indicates if this stage has multiple output ports.
- Returns
- bool
True if stage has multiple output ports, False otherwise.
- property input_ports: list[morpheus.pipeline.receiver.Receiver]
Input ports to this stage.
- Returns
- list[
morpheus.pipeline.pipeline.Receiver
]
Input ports to this stage.
- list[
- property is_built: bool
Indicates if this stage has been built.
- Returns
- bool
True if stage is built, False otherwise.
- property is_pre_built: bool
Indicates if this stage has been built.
- Returns
- bool
True if stage is built, False otherwise.
- async join()[source]
Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped. Typically this is called after
stop
during a graceful shutdown, but may not be called if the pipeline is terminated.- property name: str
The name of the stage. Used in logging. Each derived class should override this property with a unique name.
- Returns
- str
Name of a stage.
- property output_ports: list[morpheus.pipeline.sender.Sender]
Output ports from this stage.
- Returns
- list[
morpheus.pipeline.pipeline.Sender
]
Output ports from this stage.
- list[
- async start_async()[source]
This function is called along with on_start during stage initialization. Allows stages to utilize the asyncio loop if needed.
- stop()[source]
Stages can implement this to perform cleanup steps when pipeline is stopped.
- supports_cpp_node()[source]
Specifies whether this Stage is capable of creating C++ nodes. During the build phase, this value will be combined with
CppConfig.get_should_use_cpp()
to determine whether or not a C++ node is created. This is an instance method to allow runtime decisions and derived classes to override base implementations.- property unique_name: str
Unique name of stage. Generated by appending stage id to stage name.
- Returns
- str
Unique name of stage.
morpheus.stages.postprocess.filter_detections_stage.FilterDetectionsStage
Previous
morpheus.stages.postprocess.filter_detections_stage
Next
morpheus.stages.postprocess.generate_viz_frames_stage