Program

Pre-Built Program

acoupi_birdnet.program

BirdNET Program.

Classes:

Name	Description
BirdNETProgram	BirdNET Program Configuration.

Classes

BirdNETProgram

Bases: DetectionProgram[BirdNETConfig]

BirdNET Program Configuration.

Methods:

Name	Description
configure_model	Configure the BirdNET model.
get_file_managers	Get the file managers for the BirdNET Program.
get_message_factories	Get the message factories for the BirdNET Program.
get_recording_filters	Get the recording filters for the BirdNET Program.
get_summarisers	Get the summarisers for the BirdNET Program.
setup	Set up the BirdNET Program.

Attributes:

Name	Type	Description
config_schema

Attributes

config_schema = BirdNETConfig class-attribute instance-attribute

Functions

configure_model(config)

Configure the BirdNET model.

Returns:

Type	Description
BirdNET	The BirdNET model instance.

get_file_managers(config)

Get the file managers for the BirdNET Program.

Parameters:

Name	Type	Description	Default
config	BirdNET_ConfigSchema	The configuration schema for the acoupi_birdnet program defined in the configuration.py file and configured by a user via the CLI.	required

Returns:

Type	Description
list[RecordingSavingManager]	A list of file managers for the birdnet program.

get_message_factories(config)

Get the message factories for the BirdNET Program.

Parameters:

Name	Type	Description	Default
config	BirdNET_ConfigSchema	The configuration schema for the acoupi_birdnet program defined in the configuration.py file and configured by a user via the CLI.	required

Returns:

Type	Description
list[MessageBuilder]	A list of message factories for the birdnet program. By default, the message factory will use the detection_threshold parameter for buildling messages.

get_recording_filters(config)

Get the recording filters for the BirdNET Program.

Parameters:

Name	Type	Description	Default
config	BirdNET_ConfigSchema	The configuration schema for the acoupi_birdnet program defined in the configuration.py file and configured by a user via the CLI.	required

Returns:

Type	Description
list[RecordingSavingFilter]	A list of recording filters for the birdnet program. If no saving filters are defined, the method will not save any recordings.

get_summarisers(config)

Get the summarisers for the BirdNET Program.

Parameters:

Name	Type	Description	Default
config	BirdNET_ConfigSchema	The configuration schema for the acoupi_birdnet program defined in the configuration.py file and configured by a user via the CLI.	required

Returns:

Type	Description
list[Summariser]	A list of summarisers for the birdnet program. By default, the summariser will use the summariser_config.interval parameter for summarising the detections and calculating the minimum, maximum, and average confidence scores of the detections in each interval.

setup(config)

Set up the BirdNET Program.

This method initialises the birdnet program, registers the recording, detection, management, messaging, and summariser tasks, and performs any necessary setup for the program to run.