OSCalibInst




http://www.QuantTools.com
CapeTools Calibration Instruments function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index


Creates an array of Swaption calibration instruments.

To be used in the calibration of a ShortRate Model (ie BlackKarasinski, HullWhite, Vasicek, G2, LiborMarketModel).

The string 'Key' value returned from this function can be passed to the calibration functions (functions with a naming convention of Calibrate*() ) within the CapeTools IR Calibration or CapeTools LMM Calibration category of functions.

Not all calibration functions can be used with each model.

The details of the underlying swap will be extracted from the VolCurve (via the SwapTemplate object that was passed into the VolCurve creation function).

If you indicate 0.0 for any of the cells within the StrikeRange, then the ATM swap rate will be computed and used as the strike.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "SWOPTCAL"



Note: Within Excel, the function is named - CT.CAL.OSCalibInst


High level graphic of OSCalibInst() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. SwapDates parameter

    A two column range of start and end dates. These correspond to the swaps that will be created.
  4. StrikeRange parameter

    A range of strike values that corresponds to each Swaption needed to be calibrated.
  5. PayRec parameter

    Whether we are receiving or paying the fixed leg of the swap used within the calibrated Swaption instruments. Can be different for each row.
  6. VCKey parameter

    Key to an already created VolCurve object. Swaption vols will be extracted from this object.
  7. YCKey parameter

    Key to an already constructed YieldCurve object.


Extended information

Function Syntax

VB Syntax 


String CTCalibrationInsts.OSCalibInst( _
String Key, _
Long Reload, _
Variant SwapDates, _
Variant StrikeRange, _
Variant PayRec, _
String VCKey, _
String YCKey)


Excel Spreadsheet Syntax 


=CT.CAL.OSCalibInst(
Excel String Cell Key,
Excel Numeric Cell Reload,
XLRange SwapDates,
XLRange StrikeRange,
XLRange PayRec,
Excel String Cell VCKey,
Excel String Cell YCKey)


C++ Syntax 


static std::string OSCalibInst(
std::string Key,
long Reload,
CTRangeDataCPP SwapDates,
CTRangeDataCPP StrikeRange,
CTRangeDataCPP PayRec,
std::string VCKey,
std::string YCKey);


DotNET Syntax 


System.String CTCalibrationInstsSA.OSCalibInst(
System.String Key,
System.Int32 Reload,
CTRangeData SwapDates,
CTRangeData StrikeRange,
CTRangeData PayRec,
System.String VCKey,
System.String YCKey);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
SwapDatesRangeFALSE
StrikeRangeRangeFALSE
PayRecRangeFALSE
VCKeyStringTRUE
YCKeyStringTRUE

Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
KeyFALSEMyOSCalibInst
ReloadFALSE1
SwapDatesFALSEOSCalibInst_SwapDates_Range (creates a range object)
StrikeRangeTRUEOSCalibInst_StrikeRange_Range (creates a range object)
PayRecFALSEOSCalibInst_PayRec_Range (creates a range object)
VCKeyFALSEVCKeyNAME.EXTTAG.TICKER (from a function call)
YCKeyFALSEYCKeyNAME.EXTTAG.TICKER (from a function call)


Example range for parameter : SwapDates

Within Excel, a range such as this can be passed directly into the SwapDates parameter.

24/Jul/200627/Jul/2009
24/Jan/200727/Jul/2009
24/Jul/200727/Jul/2009
24/Jan/200827/Jul/2009
24/Jul/200827/Jul/2009

Example C# API usage for setting the range data for parameter : SwapDates 


CTQL.CTRangeData OSCalibInst_SwapDates = new CTQL.CTRangeData();

System.Text.StringBuilder OSCalibInst_SwapDates_builder =
new System.Text.StringBuilder(100);

OSCalibInst_SwapDates_builder.Append("{");
OSCalibInst_SwapDates_builder.Append("#24/Jul/2006#	 | #27/Jul/2009# ;");
OSCalibInst_SwapDates_builder.Append("#24/Jan/2007#	 | #27/Jul/2009# ;");
OSCalibInst_SwapDates_builder.Append("#24/Jul/2007#	 | #27/Jul/2009# ;");
OSCalibInst_SwapDates_builder.Append("#24/Jan/2008#	 | #27/Jul/2009# ;");
OSCalibInst_SwapDates_builder.Append("#24/Jul/2008#	 | #27/Jul/2009#");
OSCalibInst_SwapDates_builder.Append("}");

// Parse the string into the Range object.
OSCalibInst_SwapDates.RangeFromStr( OSCalibInst_SwapDates_builder.ToString() );

Example range for parameter : StrikeRange

Within Excel, a range such as this can be passed directly into the StrikeRange parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : StrikeRange 


CTQL.CTRangeData OSCalibInst_StrikeRange;

OSCalibInst_StrikeRange = new  CTQL.CTRangeData(0.04);

Example range for parameter : PayRec

Within Excel, a range such as this can be passed directly into the PayRec parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : PayRec 


CTQL.CTRangeData OSCalibInst_PayRec;


string[] arrBOSCalibInst_PayRec = {
"PAY",
"PAY",
"PAY",
"PAY",
"PAY"  //  Array Data

};

CTQL.StringVector arrOSCalibInst_PayRec =
new  CTQL.StringVector(arrBOSCalibInst_PayRec);

// Second parameter determines whether the array is a column array (false) or a row array (true)
OSCalibInst_PayRec = new  CTQL.CTRangeData(arrOSCalibInst_PayRec, false);


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Models20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the OSCalibInst() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the OSCalibInst() function call


MyOSCalibInst_5.SWOPTCAL.0

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.