Struct bliss_audio::Analysis
source · pub struct Analysis { /* private fields */ }Expand description
Object holding the results of the song’s analysis.
Only use it if you want to have an in-depth look of what is happening behind the scene, or make a distance metric yourself.
Under the hood, it is just an array of f32 holding different numeric features.
For more info on the different features, build the
documentation with private items included using
cargo doc --document-private-items, and / or read up
this document, that contains a description
on most of the features, except the chroma ones, which are documented
directly in this code.
Implementations§
source§impl Analysis
impl Analysis
sourcepub fn new(analysis: [f32; 20]) -> Analysis
pub fn new(analysis: [f32; 20]) -> Analysis
Create a new Analysis object.
Usually not needed, unless you have already computed and stored features somewhere, and need to recreate a Song with an already existing Analysis yourself.
sourcepub fn as_arr1(&self) -> Array1<f32>
pub fn as_arr1(&self) -> Array1<f32>
Return an ndarray Array1 representing the analysis’ features.
Particularly useful if you want to make a custom distance metric.
sourcepub fn as_vec(&self) -> Vec<f32>
pub fn as_vec(&self) -> Vec<f32>
Return a Vec
Particularly useful if you want iterate through the values to store them somewhere.
sourcepub fn custom_distance(
&self,
other: &Self,
distance: impl DistanceMetric
) -> f32
pub fn custom_distance( &self, other: &Self, distance: impl DistanceMetric ) -> f32
Compute distance between two analysis using a user-provided distance
metric. You most likely want to use song.custom_distance directly
rather than this function.
For this function to be integrated properly with the rest of bliss’ parts, it should be a valid distance metric, i.e.:
- For X, Y real vectors, d(X, Y) = 0 ⇔ X = Y
- For X, Y real vectors, d(X, Y) >= 0
- For X, Y real vectors, d(X, Y) = d(Y, X)
- For X, Y, Z real vectors d(X, Y) ≤ d(X + Z) + d(Z, Y)
Note that almost all distance metrics you will find obey these properties, so don’t sweat it too much.