itsFM
latest
Examples!
Basic Examples
Bat call example
Separating the constant frequency (CF) and frequency-modulated parts of a call
Verifying the CF-FM segmentations
The underlying frequency profile of a sound
The underlying frequency modulation rate
Performing measurements on the CF and FM parts of a call
Defining custom measurements
Segmenting with the PWVD method
How does it work?
Note
References
The peak-percentage method
How does it work?
Verifying the CF-FM segmentations
Low/high passed audio profiles
Finding the right parameter setting with the call zoo
Bird song example
Note
Setting the correct signal level
Setting a non-default FM rate
Setting the correct
max_acc
value
An example frequency profile
Inbuilt and custom measurements on CF and FM segments
Segmenting real-world sounds correctly with synthetic sounds
Synthetic calls to the rescue
Generating a ‘classical’ CF-FM bat call
A multi-component bird call
Let there be Noise
Detailed Examples Gallery
‘Difficult’ example
Step 1: the right
signal_level
How the CF-FM segmentation works
Step 2: Check the
fmrate
profile
Step 3: Set a relevant
fmrate_threshold
Summary
Using itsfm without coding:
itsfm without coding
Running a batch file analysis
Outputs from a batch file analysis
The batch file
A simple batch file
A batch file is extensible
Each row is independent
Skip a row
Run only a single row
Running parts of a batchfile
Measurement file already exists
Suppressing the ‘..already exists’ error
Which argument/s can be specified?
itsfm Accuracy
Accuracy Reports
CF-FM call segmentation accuracy
What happened before
Comparing the synthetic and the obtained results
Peak-percentage method accuracy
Putting it all together: PWVD vs peak percentage
Troubleshooting the ‘bad’ fixes - what went wrong?
Some bad PWVD identifications
Making some corrections to the PWVD output
Running CF-FM call segmentation
Dataset creation
It can take long
FM rate based segmentation
Peak-percentage based segmentation
Generating the CF-FM synthetic calls
Errors
Common Errors
1. Bad
signal_level
2. Bad
signal_level
3. Bad
signal_level
or
window_size
4. Bad
signal_level
or
window_size
Anomaly spans whole array
API reference:
API : The user interface
API : Segmenting sounds into CF and FM
API: Measuring sounds
Measurement functions
What is a
measurement function
:
Measurement function parameters
What needs to be returned:
API : Viewing sounds, parameters and results
API: support modules
Frequency tracking
The Pseudo Wigner Ville Distribution
Signal processing
Signal cleaning
Batch processing
itsFM
Docs
»
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
V
|
W
A
accelaration() (in module itsfm.frequency_tracking)
anomaly_extrapolation() (in module itsfm.signal_cleaning)
anomaly_interpolation() (in module itsfm.signal_cleaning)
assign_cffm_regionids() (in module itsfm.measure)
C
calc_coarse_fmrate() (in module itsfm.signal_cleaning)
calc_energy() (in module itsfm.signal_processing)
calc_proper_kernel_size() (in module itsfm.segment)
(in module itsfm.signal_processing)
calc_sound_borders() (in module itsfm.signal_processing)
calculate_fm_rate() (in module itsfm.segment)
CFIdentificationError
check_call_background_segmentation() (in module itsfm.view)
check_relevant_duration() (in module itsfm.segment)
check_segment_cf_and_fm() (in module itsfm.segment)
clean_up_spikes() (in module itsfm.frequency_tracking)
clip_tfr() (in module itsfm.signal_cleaning)
combine_and_order_regions() (in module itsfm.measure)
common_measurements() (in module itsfm.measure)
conditionally_set_to() (in module itsfm.signal_cleaning)
D
dB() (in module itsfm.signal_processing)
detect_local_potholes() (in module itsfm.signal_cleaning)
duration() (in module itsfm.measurement_functions)
E
exterpolate_over_anomalies() (in module itsfm.signal_cleaning)
extrapolate_sensibly() (in module itsfm.signal_cleaning)
F
find_geq_signallevel() (in module itsfm.frequency_tracking)
find_lowest_intense_harmonic_across_TFR() (in module itsfm.frequency_tracking)
find_non_forbidden_index() (in module itsfm.signal_cleaning)
find_regions() (in module itsfm.measure)
fit_polynomial_on_downsampled_version() (in module itsfm.segment)
fix_island_anomaly() (in module itsfm.signal_cleaning)
form_consensus_moving_rms() (in module itsfm.signal_processing)
fraction_duration() (in module itsfm.segment)
frequency_spike_detection() (in module itsfm.frequency_tracking)
G
generate_pwvd_frequency_profile() (in module itsfm.frequency_tracking)
get_all_spikeish_indices() (in module itsfm.signal_cleaning)
get_cf_region() (in module itsfm.segment)
get_fftsize() (in module itsfm.view)
get_first_region_above_threshold() (in module itsfm.frequency_tracking)
get_fm_regions() (in module itsfm.segment)
get_frequency_resolution() (in module itsfm.signal_processing)
get_midpoint_of_a_region() (in module itsfm.frequency_tracking)
get_most_intense_harmonic() (in module itsfm.frequency_tracking)
get_neighbouring_regions() (in module itsfm.signal_cleaning)
get_peak_frequency() (in module itsfm.signal_processing)
get_power_spectrum() (in module itsfm.signal_processing)
get_pwvd_frequency_profile() (in module itsfm.frequency_tracking)
get_robust_peak_frequency() (in module itsfm.signal_processing)
get_terminal_frequency() (in module itsfm.signal_processing)
get_thresholds_re_max() (in module itsfm.segment)
I
identify_cf_ish_regions() (in module itsfm.segment)
identify_maximum_contiguous_regions() (in module itsfm.segment)
identify_pothole_samples() (in module itsfm.signal_cleaning)
identify_valid_regions() (in module itsfm.segment)
ImproperArguments
IncorrectThreshold
itsfm.batch_processing (module)
itsfm.frequency_tracking (module)
itsfm.measure (module)
itsfm.measurement_functions (module)
itsfm.segment (module)
itsfm.signal_cleaning (module)
itsfm.signal_processing (module)
itsfm.user_interface (module)
itsfm.view (module)
itsFMInspector (class in itsfm.view)
L
load_raw_audio() (in module itsfm.batch_processing)
low_and_highpass_around_threshold() (in module itsfm.segment)
M
make_overview_figure() (in module itsfm.view)
make_specgram() (in module itsfm.view)
make_to_oned_dataframe() (in module itsfm.batch_processing)
measure_hbc_call() (in module itsfm.measure)
measure_peak_amplitude() (in module itsfm.measurement_functions)
measure_peak_frequency() (in module itsfm.measurement_functions)
measure_rms() (in module itsfm.measurement_functions)
measure_terminal_frequency() (in module itsfm.measurement_functions)
measurement_file_action() (in module itsfm.batch_processing)
median_filter() (in module itsfm.segment)
(in module itsfm.signal_processing)
moving_rms() (in module itsfm.signal_processing)
moving_rms_edge_robust() (in module itsfm.signal_processing)
O
onepass_identify_potholes() (in module itsfm.signal_cleaning)
onerow_used_properly() (in module itsfm.batch_processing)
P
parse_batchfile_row() (in module itsfm.batch_processing)
parse_cffm_segments() (in module itsfm.measure)
perform_segment_measurements() (in module itsfm.measure)
plot_accelaration_profile() (in module itsfm.view)
plot_dbrms_cffmprofiles() (in module itsfm.view)
plot_movingdbrms() (in module itsfm.view)
pre_process_for_segmentation() (in module itsfm.segment)
pwvd_transform() (in module itsfm.frequency_tracking)
R
refine_candidate_regions() (in module itsfm.segment)
refine_cf_fm_candidates() (in module itsfm.segment)
remove_bursts() (in module itsfm.signal_cleaning)
remove_punctuations() (in module itsfm.batch_processing)
resize_by_adding_one_sample() (in module itsfm.segment)
(in module itsfm.signal_processing)
rms() (in module itsfm.signal_processing)
run_from_batchfile() (in module itsfm.batch_processing)
S
save_measurements_to_file() (in module itsfm.batch_processing)
save_overview_graphs() (in module itsfm.user_interface)
segment_and_measure_call() (in module itsfm.user_interface)
segment_by_peak_percentage() (in module itsfm.segment)
segment_by_pwvd() (in module itsfm.segment)
segment_call_from_background() (in module itsfm.segment)
segment_call_into_cf_fm() (in module itsfm.segment)
segment_cf_regions() (in module itsfm.segment)
segments_above_min_duration() (in module itsfm.signal_cleaning)
show_all_call_parts() (in module itsfm.view)
smooth_over_potholes() (in module itsfm.signal_cleaning)
speed() (in module itsfm.frequency_tracking)
start() (in module itsfm.measurement_functions)
stop() (in module itsfm.measurement_functions)
subset_batch_data() (in module itsfm.batch_processing)
suppress_background_noise() (in module itsfm.signal_cleaning)
suppress_frequency_spikes() (in module itsfm.signal_cleaning)
suppress_to_zero() (in module itsfm.signal_cleaning)
T
to_list_w_funcs() (in module itsfm.batch_processing)
to_separate_from_background() (in module itsfm.batch_processing)
track_peak_frequency_over_time() (in module itsfm.frequency_tracking)
V
visualise_accelaration() (itsfm.view.itsFMInspector method)
visualise_cffm_segmentation() (itsfm.view.itsFMInspector method)
visualise_fmrate() (itsfm.view.itsFMInspector method)
visualise_fmrate_profile() (in module itsfm.view)
visualise_frequency_profiles() (itsfm.view.itsFMInspector method)
visualise_geq_signallevel() (itsfm.view.itsFMInspector method)
visualise_pkpctage_profiles() (itsfm.view.itsFMInspector method)
visualise_sound() (in module itsfm.view)
W
whole_audio_fmrate() (in module itsfm.segment)
Read the Docs
v: latest
Versions
latest
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.