jdplus.stl.base.api.SeasonalSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdplus-stl-base-api Show documentation

${project.parent.artifactId} - ${project.artifactId}

The newest version!

/*
 * Copyright 2022 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.2 or – as soon they will be approved 
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * https://joinup.ec.europa.eu/software/page/eupl
 *
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and 
 * limitations under the Licence.
 */
package jdplus.stl.base.api;

/**
 * Contains specifications for the seasonal filter itself and for the low-pass
 * filter used to remove a possible trend in the seasonal component computed by
 * the seasonal filter
 *
 * @author Jean Palate 
 */
@lombok.Value
@lombok.Builder(toBuilder = true, builderClassName = "Builder")
public class SeasonalSpec {

    public static SeasonalSpec createDefault(int period, boolean nojump) {
        LoessSpec s = LoessSpec.defaultSeasonal(nojump);
        LoessSpec t = LoessSpec.defaultLowPass(period, nojump);
        return new SeasonalSpec(period, s, t);
    }

    public SeasonalSpec() {
        this.period = 12;
        this.seasonalSpec = LoessSpec.defaultSeasonal(true);
        this.lowPassSpec = LoessSpec.defaultLowPass(period, true);
    }

    private final int period;
    private final LoessSpec seasonalSpec;
    private final LoessSpec lowPassSpec;

    public SeasonalSpec(int period, int swindow, boolean nojump) {
        this.period = period;
        this.seasonalSpec = LoessSpec.defaultSeasonal(swindow, nojump);
        this.lowPassSpec = LoessSpec.defaultLowPass(period, nojump);
    }

    public SeasonalSpec(int period, LoessSpec sspec, LoessSpec lspec) {
        this.period = period;
        this.seasonalSpec = sspec;
        this.lowPassSpec = lspec;
    }

    @Override
    public String toString() {
        return "seas-" + period;
    }
}