/*
* @(#)AclfPyGateway.java
*
* Copyright (C) 2005-17 www.interpss.org
*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*
* @Author Mike Zhou
* @Version 1.0
* @Date 04/7/2017
*
* Revision History
* ================
*
*/
package org.interpss.service;
import org.apache.commons.math3.complex.Complex;
import org.interpss.IpssCorePlugin;
import org.interpss.service.train_data.ITrainCaseBuilder;
import org.interpss.service.train_data.multiNet.IMultiNetTrainCaseBuilder;
import org.interpss.service.util.UtilFunction;
import com.interpss.common.exp.InterpssException;
/**
* InterPSS AC Loadflow training data service gateway
*
* @author Mike
*
*/
public class AclfTrainDataGenerator {
public ITrainCaseBuilder trainCaseBuilder;
/*
* Multi-Network object functions
* ==============================
*/
/**
* Load multiple loadflow cases in IEEE CMD format and create the TrainCaseBuilder object
*
* @param filenames Loadflow case filesnames "file1,file2,...". It could be a dir path.
* @param buildername training set builder name (see details in TrainDataBuilderFactory.java)
* @param busIdMappingFile busId mapping filename
* @param branchIdMappingFile branchId mapping filename
* @param netOptPatternFile network operation pattern info filename
* @return an int[3] array, [bus nn��model dimension, branch nn��model dimension, no of NetOptPattern]
*/
public int[] loadMultiCases(String filenames, String buildername,
String busIdMappingFile, String branchIdMappingFile,
String netOptPatternFile) {
IpssCorePlugin.init();
try {
this.trainCaseBuilder = UtilFunction.createMultiNetBuilder(filenames, buildername,
busIdMappingFile, branchIdMappingFile, netOptPatternFile);
} catch ( InterpssException e) {
e.printStackTrace();
return new int[] {0, 0};
}
return new int[] {this.trainCaseBuilder.getNoBus(),
this.trainCaseBuilder.getNoBranch(),
((IMultiNetTrainCaseBuilder)this.trainCaseBuilder).getNoNetOptPatterns()};
}
/*
* Single Network object functions
* ===============================
*/
/**
* Load a loadflow case in IEEE CMD format and create the TrainCaseBuilder object
*
* @param filename
* @param buildername training set builder name (see details in TrainDataBuilderFactory.java)
* @return an int[2] array, [bus nn��model dimension, branch nn��model dimension]
*/
public int[] loadCase(String filename, String buildername) {
IpssCorePlugin.init();
try {
this.trainCaseBuilder = UtilFunction.createSingleNetBuilder(filename, buildername);
} catch ( InterpssException e) {
e.printStackTrace();
return new int[] {0, 0};
}
return new int[] {this.trainCaseBuilder.getNoBus(), this.trainCaseBuilder.getNoBranch()};
}
/**
* Load a loadflow case in IEEE CMD format and create the TrainCaseBuilder object
*
* @param filename
* @param buildername training set builder name (see details in TrainDataBuilderFactory.java)
* @param busIdMappingFile
* @param branchIdMappingFile
* @return an int[2] array, [bus nn��model dimension, branch nn��model dimension]
*/
public int[] loadCase(String filename, String buildername, String busIdMappingFile, String branchIdMappingFile) {
IpssCorePlugin.init();
try {
this.trainCaseBuilder = UtilFunction.createSingleNetBuilder(filename, buildername, busIdMappingFile, branchIdMappingFile);
} catch ( InterpssException e) {
e.printStackTrace();
return new int[] {0, 0};
}
return new int[] {this.trainCaseBuilder.getNoBus(), this.trainCaseBuilder.getNoBranch()};
}
/*
* Common functions
* ================
*/
/**
* create and return a set of training cases,
*
* Data format: [2][points][]
* [
* [input, output], ... [input, output]
* ]
*
* input/output is a string of "x1 x2 ...", representing
* a double[] for the large-scale array performance reason.
*
* @param points number of training cases
* @return the training set
*/
public String[][] getTrainSet(int points) {
String[][] trainSet = new String[2][points];
for (int i = 0; i < points; i++) {
this.trainCaseBuilder.createTrainCase(i, points);
double[] input = this.trainCaseBuilder.getNetInput();
double[] output = this.trainCaseBuilder.getNetOutput();
trainSet[0][i] = UtilFunction.array2String(input);
trainSet[1][i] = UtilFunction.array2String(output);
}
return trainSet;
}
/**
* create and return a random test case,
*
* Data format: [2][]
* [
* input, output
* ]
*
* input/output is a string of "x1 x2 ...", representing
* a double[] for the large-scale array performance reason.
* @return the training set
*/
public String[][] getTestCase() {
String [][] data = new String[2][1];
this.trainCaseBuilder.createTestCase();
double[] input = this.trainCaseBuilder.getNetInput();
double[] output = this.trainCaseBuilder.getNetOutput();
data[0][0] = UtilFunction.array2String(input);
data[1][0] = UtilFunction.array2String(output);
return data;
}
/**
* create and return a test case using the factor to generate the case,
*
* Data format: [2][]
* [
* input, output
* ]
* input/output is a string of "x1 x2 ...", representing
* a double[] for the large-scale array performance reason.
*
* @param factor some value for creating the test case
* @return the training set
*/
public String[][] getTestCase(double factor) {
String [][] data = new String[2][1];
this.trainCaseBuilder.createTestCase(factor);
double[] input = this.trainCaseBuilder.getNetInput();
double[] output = this.trainCaseBuilder.getNetOutput();
data[0][0] = UtilFunction.array2String(input);
data[1][0] = UtilFunction.array2String(output);
return data;
}
/**
* compute and return the mismatch info based on the network solution
* for bus voltage
*
* @param netVolt network bus voltage solution
* @return mismatch info string
*/
public String getMismatchInfo(double[] netVolt) {
return this.trainCaseBuilder.calMismatch(netVolt).toString();
}
/**
* compute and return the mismatch based on the network solution
* for bus voltage
*
* @param netVolt network bus voltage solution
* @return mismatch info string
*/
public double[] getMismatch(double[] netVolt) {
Complex maxMis= this.trainCaseBuilder.calMismatch(netVolt).maxMis;
return new double[] {maxMis.getReal(),maxMis.getImaginary()};
}
}
