Clarified Instance documentation and methods

This commit is contained in:
DataHoarder 2022-07-16 17:22:17 +02:00
parent a634415bff
commit 1c7b7b0d97
Signed by: DataHoarder
SSH key fingerprint: SHA256:OLTRf6Fl87G52SiR7sWLGNzlJt4WOX+tfI2yxo0z7xk
2 changed files with 12 additions and 7 deletions

View file

@ -41,7 +41,7 @@ type Instance struct {
//QueryTimeRatioFactor in ratio factor. Any match with its time ratio below or above 1 +- this value will not be considered
QueryTimeRatioFactor float64
//QueryFrequencyRatioFactor in ratio factor. Any match with its frequency ratio below or above 1 +- this value will not be considered
//TODO: maybe change this to work on octaves?
//TODO: maybe change this to work on Octave or Cent?
QueryFrequencyRatioFactor float64
//QueryDurationPercentageMinimum in absolute percentage. Any match with its duration % ratio below this value will not be considered
@ -91,7 +91,7 @@ func NewDefaultInstance() *Instance {
TransformMinimumFrequency: 110,
TransformReferenceFrequencyOffset: 2, //440Hz, TODO: how was this value achieved
TransformMaximumFrequencyOffset: 6, //7040Hz, TODO: how was this value achieved
//constant, other dependencies exist
//constant, other dependencies exist. TODO: remove or make dependencies relative
TransformBands: 512,
TransformTimeResolution: time.Millisecond * 8, //8ms
QueryRange: 3, //could be 2?
@ -138,11 +138,16 @@ func (i *Instance) GetEventPointProcessor() (*EventPointProcessor, error) {
func (i *Instance) GetTransformBandsPerOctave() int {
return i.TransformBands / int(i.TransformMaximumFrequencyOffset)
}
func (i *Instance) GetTransformReferenceFrequencyInHertz() Hertz {
func (i *Instance) GetTransformMinimumFrequency() Hertz {
return i.TransformMinimumFrequency
}
func (i *Instance) GetTransformReferenceFrequency() Hertz {
return i.TransformMinimumFrequency.Octaves(i.TransformReferenceFrequencyOffset)
}
func (i *Instance) GetTransformMaximumFrequencyInHertz() Hertz {
func (i *Instance) GetTransformMaximumFrequency() Hertz {
return i.TransformMinimumFrequency.Octaves(i.TransformMaximumFrequencyOffset)
}

View file

@ -47,9 +47,9 @@ func NewEventPointProcessor(instance *Instance) (*EventPointProcessor, error) {
instance.BlockSize,
float64(instance.SampleRate),
instance.GetTransformBandsPerOctave(),
float64(instance.TransformMinimumFrequency),
float64(instance.GetTransformMaximumFrequencyInHertz()),
float64(instance.GetTransformReferenceFrequencyInHertz()),
float64(instance.GetTransformMinimumFrequency()),
float64(instance.GetTransformMaximumFrequency()),
float64(instance.GetTransformReferenceFrequency()),
instance.GetTransformTimeResolutionInSamples(),
)