Files
playbook/skills/tsl-api-reference/references/codegen/module/ts-event-statistical-analysis.md
T

308 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 事件套利 / 事件统计
## `TSEventStatisticalAnalysis`
声明:class
事件套利统计框架
<!-- tags: 分析 汇总 事件驱动 事件研究 统计检验 事件套利 -->
### `fData`
声明:field
事件样本数据 空
可见性:`public`
类型:array
### `fDayArr`
声明:field
事件窗窗口序列 Array(-1,0,1)
可见性:`public`
类型:array
### `fCycle`
声明:field
周期(事件窗时间序列间隔单位) 日线
可见性:`public`
类型:string
### `fIndexID`
声明:field
(计算事件基准收益率)基准代码 SH000300
可见性:`public`
类型:string
### `fCtype`
声明:field
事件效应拓展指标 0
可见性:`public`
类型:int
### `getSampleData()`
声明:function
此方法用于获取用户构建的事件样本数据。当通过 FData方式设置事件样本数据不满足场景
<!-- tags: 查询 配置 生成 事件驱动 事件研究 -->
可见性:`public`
返回:array
### `getSampleData2(data)`
声明:function
根据事件样本生成实际研究对象数据;研究样本不同于事件样本时可重写
<!-- tags: 查询 研究样本 事件样本 研究对象 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------ | ----- | ----------------------------------------------- |
| `data` | array | FData或 GetSampleData()方法所返回的事件样本数据 |
返回:array
### `getDayArr()`
声明:function
此方法用于获取事件窗窗口序列。功能同 FDayArr,当设置 FDayArr方式无法满足要求时
<!-- tags: 查询 配置 事件驱动 事件研究 拟合优度 决定系数 -->
可见性:`public`
返回:array
### `getStockReturn(stock_id, beg_t, end_t)`
声明:function
此方法用于获取样本实际收益数据。默认取该样本区间涨幅(%)(区间包含 Begt,Endt
<!-- tags: 查询 回报率 投资收益 证券 个股 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | -------- | -------------------- |
| `stock_id` | string | String,样本证券代码 |
| `beg_t` | datetime | DateTime,区间开始日 |
| `end_t` | datetime | DateTime,区间截止日 |
返回:real
### `getIndexReturn(stock_id, beg_t, end_t)`
声明:function
此方法用于获取样本基准收益数据。默认取该基准代码 FIndexID区间涨幅(%)(区间包含
<!-- tags: 查询 回报率 投资收益 比较基准 业绩基准 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | -------- | -------------------- |
| `stock_id` | string | String,样本证券代码 |
| `beg_t` | datetime | DateTime,区间开始日 |
| `end_t` | datetime | DateTime,区间截止日 |
返回:real
### `getIndexByEndT(stock_id, end_t)`
声明:function
此方法用于获取基准指数代码(支持股票所属行业指数作为基准指数),与成员变量
<!-- tags: 查询 证券 个股 指数产品 行业分类 板块 比较基准 业绩基准 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ---------- | -------- | -------------------- |
| `stock_id` | string | String,样本证券代码 |
| `end_t` | datetime | DateTime,截止日 |
返回:string
### `get_Ret_Detail(date_opt, return_opt, return_type)`
声明:function
获取事件窗内实际、基准或超额收益的累计、复合或每日明细
<!-- tags: 查询 回报率 投资收益 事件驱动 事件研究 主动收益 比较基准 业绩基准 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| `date_opt` | datetime | Int,日期显示控制 取值 含义 备注 0 不显示日期 1 显示开始日、截止日 默认 |
| `return_opt` | integer | Int,收益显示控制 取值 含义 备注 0 显示全部(含基准收益) 默认 1 仅显示超额收益(%) 2 仅显示实际收益(%) |
| `return_type` | integer | Int,返回收益率类型 取值 含义 备注 0 累计收益率 默认 1 复合收益率 2 每日收益率 |
返回:array
### `get_Ret_Performance(return_opt, method)`
声明:function
统计事件收益在各事件窗窗口上的表现
<!-- tags: 查询 汇总 回报率 投资收益 绩效 业绩表现 事件驱动 事件研究 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | ------- | --------------------------------------------------------- |
| `return_opt` | integer | Int,收益显示控制 |
| `method` | integer | Int,收益率合成方式 取值 含义 备注 0 平均值 默认 1 中位数 |
返回:array
### `get_Ret_Performance2(n, rsp_cy, return_opt, method)`
声明:function
此方法用于获取事件收益在指定事件窗窗口下时间轴上的表现
<!-- tags: 查询 回报率 投资收益 事件驱动 事件研究 时间处理 日期时间 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------- |
| `n` | integer | Int,事件窗窗口值,必须属于 FDayArr事件窗窗口序列,默认:0 |
| `rsp_cy` | string | String,采样周期,频率不得高于 FCycle,默认:月线 |
| `return_opt` | integer | Int,收益显示控制 取值 含义 备注 0 显示超额收益(%)+实际收益(%) 默认 1 仅显示超额收益(%) 2 仅显示实际收益(%) |
| `method` | integer | Int,收益率合成方式 取值 含义 备注 0 平均值 默认 1 中位数 |
返回:array
### `get_Ret_Describe(return_opt)`
声明:function
此方法用于获取事件收益基本统计(按事件窗)
<!-- tags: 查询 汇总 回报率 投资收益 事件驱动 事件研究 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `return_opt` | integer | Int,计算所用收益类型 取值 含义 备注 0 超额收益-累计 (%) 默认 1 实际收益-累计 (%) 2 超额收益-复合 (%) 3 实际收益-复合 (%) 4 超额收益-每日(%) 5 实际收益-每日(%) |
返回:array
### `get_Ret_Describe2(rsp_cy, n, return_opt)`
声明:function
此方法用于获取事件收益基本统计(按时间轴)
<!-- tags: 查询 汇总 回报率 投资收益 事件驱动 事件研究 时间处理 日期时间 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rsp_cy` | string | String,采样周期,频率不得高于 FCycle,默认:月线 |
| `n` | integer | Int,事件窗窗口值,必须属于 FDayArr事件窗窗口序列,默认:0 |
| `return_opt` | integer | Int,计算所用收益类型 取值 含义 备注 0 超额收益-累计 (%) 默认 1 实际收益-累计 (%) 2 超额收益-复合 (%) 3 实际收益-复合 (%) 4 超额收益-每日(%) 5 实际收益-每日(%) |
返回:array
### `get_Ret_StatofAlpha()`
声明:function
此方法用于获取事件超额(异常)累计收益率统计检验数据(按事件窗)
<!-- tags: 查询 检查 判定 验证 汇总 回报率 投资收益 事件驱动 -->
可见性:`public`
返回:array
### `get_Ret_StatofAlpha2(rsp_cy, n)`
声明:function
此方法用于获取事件超额(异常)累计收益率统计检验数据(按时间轴)
<!-- tags: 查询 检查 判定 验证 汇总 回报率 投资收益 事件驱动 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| -------- | ------- | ---------------------------------------------------------- |
| `rsp_cy` | string | String,采样周期,频率不得高于 FCycle,默认:月线 |
| `n` | integer | Int,事件窗窗口值,必须属于 FDayArr事件窗窗口序列,默认:0 |
返回:array
### `get_Ret_Detail2(data_opt, return_opt, ctype)`
声明:function
获取换手率、成交量或成交金额等事件效应扩展指标明细
<!-- tags: 查询 回报率 投资收益 事件驱动 事件研究 交易频率 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data_opt` | integer | 日期显示控制:0 不显示日期;1 显示开始日和截止日(默认) |
| `return_opt` | integer | Int,收益显示控制 取值 含义 备注 0 显示全部(含基准指标) 默认 1 仅显示异常指标 2 仅显示实际指标 |
| `ctype` | integer | Int,事件效应指标选择 取值 含义 备注 1 换手率 2 成交量 3 成交金额 ⚫ 说明 1:此方法用于获取事件效应拓展指标详情数据,此数据为日均数据,日均指标计算 |
返回:array
### `get_Ret_Performance3(return_opt, method, ctype, begt, endt)`
声明:function
获取指定区间的事件效应扩展指标表现
<!-- tags: 查询 回报率 投资收益 事件驱动 事件研究 -->
可见性:`public`
| 参数 | 类型 | 说明 |
| ------------ | -------- | ------------------------------------------------------------------------------------------------------- |
| `return_opt` | integer | Int,组合拓展指标显示控制 取值 含义 备注 0 显示异常指标+实际指标 默认 1 仅显示异常指标 2 仅显示实际指标 |
| `method` | integer | Int,组合拓展指标合成方式 取值 含义 备注 0 平均值 默认 1 中位数 |
| `ctype` | integer | Int,事件效应指标选择 取值 含义 备注 1 换手率 2 成交量 3 成交金额 |
| `begt` | datetime | Date,组合拓展指标计算区间开始日,默认不设置,计算所有拓展指标 |
| `endt` | datetime | Date,组合拓展指标计算区间截止日,默认不设置,计算所有拓展指标 |
返回:array