Hilbert Transform - Dominant Cycle Period

dominant_cycle_period() is a generic S3 function that preserves the input class: data.frame in, data.frame out; matrix in, matrix out.

dominant_cycle_period() also accepts a double vector, in which case the indicator is calculated directly without column selection. When the result has a single column it is simplified to a double vector; otherwise the full n by k matrix is returned.

Handling of -values

Leading NAs are always produced for the initial lookback period where insufficient data is available. If the input itself contains NAs they are passed through to the underlying C routine, which can cause the entire output to be filled with NAs. Set na.ignore = TRUE to strip NAs before calculation and re-insert them at their original positions in the output.

Usage

dominant_cycle_period(x, cols, na.ignore = FALSE, ...)

Arguments

x

An OHLC-V series coercible to data.frame. Alternatively, x may also be supplied as a double vector.

cols

(formula). An optional 1-variable formula selecting columns from x via model.frame. Defaults to ~close.

na.ignore

(logical). A logical of length 1. FALSE by default. If TRUE, NAs in the input are stripped before calculation and re-inserted at their original positions in the output.

...

Additional parameters passed into model.frame

Value

An object of same class and length of x:

HT_DCPERIOD

double

See also

Other Cycle Indicator: dominant_cycle_phase(), phasor_components(), sine_wave(), trend_cycle_mode()

Author

Serkan Korkmaz

Examples

## load Bitcoin (BTC)
## series
data(BTC, package = "talib")

## calculate the indicator
## for Bitcoin (BTC)
output <- talib::dominant_cycle_period(BTC)

## display the results
utils::tail(output)
#>                     HT_DCPERIOD
#> 2024-12-26 01:00:00    18.81349
#> 2024-12-27 01:00:00    18.57286
#> 2024-12-28 01:00:00    18.04285
#> 2024-12-29 01:00:00    17.44146
#> 2024-12-30 01:00:00    16.96749
#> 2024-12-31 01:00:00    16.75481

## visualize the indicator
## with talib::chart()
##
## see ?talib::chart or ?talib::indicator
## for more details
{
 ## chart OHLC-V
 ## series with talib::chart()
 talib::chart(BTC)

 ## chart indicator
 ## with default values
 talib::indicator(
     talib::dominant_cycle_period
 )
}