Candlestick Patterns
On Neck
Introduction
Create a new On-Neck candlestick pattern indicator to indicate the pattern's presence.
To view the implementation of this candlestick pattern, see the LEAN GitHub repository.
Using OnNeck Indicator
To create an automatic indicators for OnNeck
, call the OnNeck
helper method from the QCAlgorithm
class. The OnNeck
method creates a OnNeck
object, hooks it up for automatic updates, and returns it so you can used it in your algorithm. In most cases, you should call the helper method in the initialize
method.
class OnNeckAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._on_neck = self.candlestick_patterns.on_neck(self._symbol) def on_data(self, slice: Slice) -> None: if self._on_neck.is_ready: # The current value of self._on_neck is represented by self._on_neck.current.value self.plot("OnNeck", "on_neck", self._on_neck.current.value)
The following reference table describes the OnNeck
method:
on_neck(symbol, resolution=None, selector=None)
If you don't provide a resolution, it defaults to the security resolution. If you provide a resolution, it must be greater than or equal to the resolution of the security. For instance, if you subscribe to hourly data for a security, you should update its indicator with data that spans 1 hour or longer.
For more information about the selector argument, see Alternative Price Fields.
For more information about plotting indicators, see Plotting Indicators.
You can manually create a OnNeck
indicator, so it doesn't automatically update. Manual indicators let you update their values with any data you choose.
Updating your indicator manually enables you to control when the indicator is updated and what data you use to update it. To manually update the indicator, call the update
method with a TradeBar
. The indicator will only be ready after you prime it with enough data.
class OnNeckAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._on_neck = OnNeck() def on_data(self, slice: Slice) -> None: bar = slice.bars.get(self._symbol) if bar: self._on_neck.update(bar) if self._on_neck.is_ready: # The current value of self._on_neck is represented by self._on_neck.current.value self.plot("OnNeck", "on_neck", self._on_neck.current.value)
To register a manual indicator for automatic updates with the security data, call the register_indicator
method.
class OnNeckAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol self._on_neck = OnNeck() self.register_indicator(self._symbol, self._on_neck, Resolution.DAILY) def on_data(self, slice: Slice) -> None: if self._on_neck.is_ready: # The current value of self._on_neck is represented by self._on_neck.current.value self.plot("OnNeck", "on_neck", self._on_neck.current.value)
The following reference table describes the OnNeck
constructor:
OnNeck
On-Neck candlestick pattern indicator
get_enumerator()
Returns an enumerator that iterates through the history window.
IEnumerator[IndicatorDataPoint]
reset()
Resets this indicator to its initial state
to_detailed_string()
Provides a more detailed string of this indicator in the form of {Name} - {Value}
str
update(time, value)
Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- time (datetime)
- value (float)
bool
update(input)
Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise
- input (IBaseData)
bool
consolidators
The data consolidators associated with this indicator if any
The data consolidators associated with this indicator if any
ISet[IDataConsolidator]
current
Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
is_ready
Gets a flag indicating when this indicator is ready and fully initialized
Gets a flag indicating when this indicator is ready and fully initialized
bool
item
Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.
Indexes the history windows, where index 0 is the most recent indicator value. If index is greater or equal than the current count, it returns null. If the index is greater or equal than the window size, it returns null and resizes the windows to i + 1.
IndicatorDataPoint
name
Gets a name for this indicator
Gets a name for this indicator
str
period
Gets the period of this window indicator
Gets the period of this window indicator
int
previous
Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
Gets the previous state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.
IndicatorDataPoint
samples
Gets the number of samples processed by this indicator
Gets the number of samples processed by this indicator
int
warm_up_period
Required period, in data points, to the indicator to be ready and fully initialized
Required period, in data points, to the indicator to be ready and fully initialized
int
window
A rolling window keeping a history of the indicator values of a given period
A rolling window keeping a history of the indicator values of a given period
RollingWindow[IndicatorDataPoint]
Indicator History
To get the historical data of the OnNeck
indicator, call the self.indicator_history
method.
This method resets your indicator, makes a history request, and updates the indicator with the historical data.
Just like with regular history requests, the indicator_history
method supports time periods based on a trailing number of bars, a trailing period of time, or a defined period of time.
If you don't provide a resolution
argument, it defaults to match the resolution of the security subscription.
class OnNeckAlgorithm(QCAlgorithm): def initialize(self) -> None: self._symbol = self.add_equity("SPY", Resolution.DAILY).symbol on_neck = self.CandlestickPatterns.on_neck(self._symbol) count_indicator_history = self.indicator_history(on_neck, self._symbol, 100, Resolution.MINUTE) timedelta_indicator_history = self.indicator_history(on_neck, self._symbol, timedelta(days=10), Resolution.MINUTE) time_period_indicator_history = self.indicator_history(on_neck, self._symbol, datetime(2024, 7, 1), datetime(2024, 7, 5), Resolution.MINUTE)
To make the indicator_history
method update the indicator with an alternative price field instead of the close (or mid-price) of each bar, pass a selector
argument.
indicator_history = self.indicator_history(on_neck, 100, Resolution.MINUTE, lambda bar: bar.high) indicator_history_df = indicator_history.data_frame